From 4b38bf0c63ea10bc2bf14f13b9c130b1ac1f55cc Mon Sep 17 00:00:00 2001 From: squioc Date: Fri, 10 Nov 2023 11:05:52 +0000 Subject: [PATCH] Refresh automation library documentation --- .../automate/library/atlassian-jira.md | 67 ++++++++++++++++++ .../playbooks/library/atlassian-jira.png | Bin 0 -> 7250 bytes mkdocs.yml | 2 + 3 files changed, 69 insertions(+) create mode 100644 _shared_content/automate/library/atlassian-jira.md create mode 100644 docs/assets/playbooks/library/atlassian-jira.png diff --git a/_shared_content/automate/library/atlassian-jira.md b/_shared_content/automate/library/atlassian-jira.md new file mode 100644 index 0000000000..592f485777 --- /dev/null +++ b/_shared_content/automate/library/atlassian-jira.md @@ -0,0 +1,67 @@ +# Atlassian JIRA + +![Atlassian JIRA](/assets/playbooks/library/atlassian-jira.png){ align=right width=150 } + +Integrates with JIRA + +## Configuration + +| Name | Type | Description | +| --------- | ------- | --------------------------- | +| `domain` | `string` | Your organization JIRA domain (e.g. 'sandbox.atlassian.net') | +| `email` | `string` | Email of the user | +| `api_key` | `string` | API Key to use to connect to JIRA API endpoints | + +## Actions + +### Change Status of an Issue + +Change status of an issue in JIRA + +**Arguments** + +| Name | Type | Description | +| --------- | ------- | --------------------------- | +| `issue_key` | `string` | Issue key (e.g. PROJ-1) | +| `status_name` | `string` | Exact name of the status (e.g. 'To Do') | + +### Comment Issue + +Add comment to an issue in JIRA + +**Arguments** + +| Name | Type | Description | +| --------- | ------- | --------------------------- | +| `issue_key` | `string` | Issue key (e.g. PROJ-1) | +| `comment` | `string` | Text of a comment | + +### Create Issue + +Create issue in JIRA + +**Arguments** + +| Name | Type | Description | +| --------- | ------- | --------------------------- | +| `project_key` | `string` | Project key (e.g. 'PRJ') | +| `summary` | `string` | Summary of an issue (e.g. 'Fix a bug') | +| `issue_type` | `string` | Issue type (e.g. 'Task') | +| `due_date` | `string` | Due date (e.g. '2023-10-31')' | +| `labels` | `string` | Comma-separated labels (e.g. 'devops,support') | +| `assignee` | `string` | Exact display name of an assignee (e.g. John Doe) | +| `reporter` | `string` | Exact display name of a reporter (e.g. Jane Doe) | +| `priority` | `string` | Issue priority (e.g. Highest) | +| `parent_key` | `string` | Key of a parent issue (e.g. PRJ-1) | + + +**Outputs** + +| Name | Type | Description | +| --------- | ------- | --------------------------- | +| `issue_key` | `string` | Key of the created issue | + + +## Extra + +Module **`Atlassian JIRA` v1.0.4** \ No newline at end of file diff --git a/docs/assets/playbooks/library/atlassian-jira.png b/docs/assets/playbooks/library/atlassian-jira.png new file mode 100644 index 0000000000000000000000000000000000000000..086d56688c4437ffbcdd31c5e0de2ad4e2849420 GIT binary patch literal 7250 zcmch6_dA<^)PF>TAXe9f-DVn0rew7Q~*GT)kqJ0Bi#A-O_o}x{)ki0FjJBiYdnYibrPi`%5S?d zJ;wj)1XvP}vJioAZ~jn44v>e5R-Tuj_#RpT$*d0O@|qUoun zl_lY&w}LY2JEvHx9xEZKe((6Rdeq4DcE0+k`q8nf<>ISLXG77K7EZU%wnue<$8I2g zI&mPL_>U?BO*ou|)331pqvz5Au*9zbu}pTlFNlMH{~Ta=0L)z%Rd~OEoeqW3rnG%Y zM36uQnS}3d->=3&ve{MZl|`83(J1%wi2MT%SNykk89t^=K$A>Jf!8@tZBYLI-(&om zs~m%qINGijk^XQuv5?Fm;lHL$m!HP6WkDv)o5cN;Sr3tPd+crSXP=I97`^uwgIqXz zei&94AWp8RS7jul&x+jQiVK66jW!tTTirbQ_WmDwXAv@db!mYA;@j{2@gC zC41uCKlr-)6z_{`xF0lZGRM6$4CRPfSA$iI#<91*q4LflK=p#bItG<7sDbB0xmB@W z_xkTm1f5316z|i^r_Y8=lF3X#tdNcTrA+W7$ zNX5WH1?J9uyRJg}EA$WsXnll?MfNMA4FYFAt_64LKfbzHzvaL$LpI4AFKp=EX>l79 z2l@V2W)KINcr30Onehp#K}Sje#0Kp|HZ*)N;fS$&P>K|_@c+*kpbAh6J_hG&iJ~xy z1~30db@gw|Sw;L?P(hP`ocw%&zD9!7zBFAaV6z2SZcrr!b9b-u4%cY^33jl! z*{iR+XbIS$Z}bh1tZtPs;phrCD^^OAZf2|fHpR#C3Z^ThWrmPPzrUk$-&NYG=#FW> z-c_bgWa)4pi$!{XC!@MFY5+05+H#BYIo!SEr(^XI{gFHx48E*doCts+AtI--<(#hg zbn1?I>zxwBvElqu)*U>6qoDD$|4?H3tm$m@^fsl3v70{L#If+i{OI2L0+)U4!IDb* zy`!UBGgo&GeUeW@4=?tkUFDd}(Tfmimlo(=$?jl)Itnw-qx5apY*yFmGuxBlS<{2w z;1o{#%{c~dxlc?_mmw&>59SqGiRqbN*X^~q_2kM#M?O4*pMG%3gk*;?KqI=8S%N9? zg0ap`Me9J77#8INzV2$bUxx~XSL-t-IEKZYF=Fb4MxPh#v_PTH0tX7Fy8oKC3c)IV zFbggphP-nwNzx`3_MKEd;v~%(C$;Epws?0l;07UQzh^&^Tf9VitHc9D`Stv?TJFMN zNX{4Ia%1v8B7jX=3!h&b1x_KBWX#=)knRb6)5ugAhoN8HDZ+3wEI$48&|C;TS0(`{ zerzYNA0Pfq(>ozw+Yvc3VBUn*ec$yFooPJzhAqCHSaB}ov(~xU+rJqNBhvD)chkMI z42p0fy`?{Y-K$E<$FkTYL%IHD_fMNx`kD~w9+sYP!}L}^3h3I8)O8vLhsw;!#g6{| z*{a_Dw|!0a0a1Ozmz=5wJ+Aitralq$8gwC>d-9n-4rt#-yoSUHoZM<|R7>8fSg(LfPSU5Z9Qpwt)pg7gsQrFr)*#3z!7^SEnh29_tZN^Vjg&12CkVGjlz^>Ho$k@#d=7ZR2p@TJzPA=^j$?L z;J$rwe!V!y>o!5jeunmy!Dfauc-}0nlAK_LRhSPrl35c8)%rTI(7JyA`&tYM@Sqc! z*J!M)lRmq`e=WXq0nwwLijZC$Az`Leg#TJk4wdP z87~SUqjMCXZl($yJDb$M=%)zP^TpDmgVSVbl0u$o_T6~C zX0%Cp9QZDi<)MAHw*W0TUE!!93nYvvxb?_JUGHh<=nkj-U(1}xrI+=ojk@_kM;pKW zh)%vg!Cg$G$k!DO=TR7!B{mh6xvFi@Qpd?q?i0tHzA1#WhR6%fb=0Qmaa8+t}lP~p8vZ`6LW5L z_GJldpEkAP{=3B59AJUMxG|-%c=0#I1J?d7z38v3%*nLRv141}Caf;c^^La~kwdm=~{v=m@ko`CIDA?&S{YV%$+QM!X$ zY)i96iNipoJ1oJz&B^zg%PoxG_Hup%Ny6s1+|6T>=96R8dVo%#-lTTrYl5cB3)$j2 zHJN`t*59cTO<|}DT3rw&6UDFirMdsRSLrtuhhQmdc`+uasF3}0`}j-0^Cc?7YV7u- z-P2HS?s%nsq;zYV8T%zR;3lcUuik~GX56Hs<$|$P!G@0+DmM)hk7_N*N(2h{Zbsyu zw_i)Z!6t)@Rf-9Sc&O2g@wv!z3?M1A-%f;-!^b%vtxBY5rVlyF?g=6Fajy1_?n&}{ z4q)hVL`(bL*E5T-PF|RMB45*by(%wN@nx_w#sQCX$^7VB1m`leUZhG~X__vdh_tmHZrgPv>rhtzC)M z_4Tlu(8WOt=b^K4aX`J~nU%LfA#yn;^&SIG2lVCW{7AYOW=6&~@wv8no=eUQv)VYSof}C7Q2i*JQf~8(N)k$W5C+$xXkY(p`_9CGk7xP(MP_L zc9;DDu8$g`_VROE558M?O5Xjuzix9uNQm6*Ufu6Dxepw)LRIxT>F@P zsc$Vtim>XA#TALc!}Nn(6>{DbajD@FtnaO2pdR#kSkMtkS z%5p^)P7&V*5=1kgTrbY6^Y2U}oF5%*n(FSR+1e<{!72u%9=vc={h==W)uvK~5T+V7AtABi>O9)J9p`yPb4i+v+H+o z(>>uv@1y01Gpdaam**6_PLncRH=^H%!09hTv19j{!aJE_3r5h$H&Jz7^IfX-uJDQh zDy4c+r zk9iLDln4_YJk7tQbcebIK$3~~d{^4hs`UGpN@Ut#Pdr#)yGI}HSM2yEBa13-2ldS& zwRP3rcT&J4t#g-W=dtS4``C?y>V9hh+0sqXyby_#q#|1{>eZQUwst3%PP=u4Ej&1o zao+`?e3PC%suj2qbuotv>Hiiev4X=G5Am9;^RoG^aHa1o1~EReX=<@s^OJkT)6hvaX|q&Rw9} zFOgvw#K@?X;hHdtUBMsca@(IMgtwb5f@%=0sueS45TB^>=wN(9_GhmwH1KQgxJ|L? z#I-b-f6#?@R59F=E5;a6>>MFi5$2ElY0V5)Ei9`#*wipjP?`xg6gX(Buwc$s(iI-W z_{-gvvk_qVDi^c@l+mg6oE4qP5nkQK9kB0YkD>#G<)vC(ap}1YH>-W~5tHB;Cjk2+ z1)T~0)-iPqqboj_uG^%l@d6_r>KO`@xzFPExP<(dJXUQma9LhdW)O5HV?LoSfE zqd}T+QJZeaSKPTR1kt*f?S@!uz|-VS$^o@Ki;KFOi>jCDx5K+$yh zw3S)o^=LDjhpNB*;x%Og+9r_bB3C`UF6Xj8y^?aI$U(82DB0r<`z(gDO*yD!{2D3P z*ZX|DswO4is(QG(il$lubVB_Se=*6j(DnTLI1YmmbTrGnf0Kk)@pH~|_h93aa^eFwioVz~nS1oB znMdg0PzANYqtqO-FybNN*RO#;L~%6khP z8jbydAFNb=oCkFFa2NOLmS{7-zSNrIm)U)#-nRlb2Kl?|6u)rcnZ(4E%l_z#>yN{6 zv)p}wN(2+J7dQmCe*f^QrAgt!y|bTjS?gHExvCKS=Hx3s&K@wY?$B=vatb4N%gr&y)WMq1fMX_6#<4DRLN!!VB2=&9KrCVbwN2NNXmg~kAnCd zHliivdr=`Is9&(+2UfP`w2(og)+%Y2H_U2v()sS=`?W+nk&8D+FkCViHh!_Nd3xOJ zW(L~+x$)>VuyEdJQ(-+kN4LsHulh8U=e1_TcNv=({60LmtjdhA zS${L8qd5X)eQCZc#p{M2HotR6OHV|CDv(@OWo*i!soS1<{)+1}oAiWUyM$aO9JSoG zl^Q;2Y%v`J+icT<7G8#Kg~ol~o|hvR7FdM#^XY9LwbZ3HqmOSjW&ABXp-kIHynj;8 z217DnU>5GyX;u2Gq><>oYuwXT6^!XmYb9b^<)6RV@TuYQ<2Xw!CMG?ItVy^BY^+Zt z(5hs>PfThPljYNqk@Z1~Kh#A0-nHcxo2Mq}PwVW}lqIvg){kb$1x(o8kk8Pj@=$;| zApbM7_AJ6-N$8H-O?*BbluLQWiV|VY!y}~h^JaqpC#~cIo>CZIcHMZl3#jM4Vm;~J z2p$K08%QHESu!v{upg8{8wTF5zWN-x+I4VPGOe6){Ny9#-LBTyIUvK!UznmEdADbqLvyD0N;R-&*FVm?p!$aIQ0mQWI zOU%v)-Q|_uU&jo1vELDz1KpMQ7}?NYyY!I3^)k75?{Jw*M#^Lw|1mWLF3r?2YoCS;|l33|N=%n}ZXm?rh9#yzd0G6ybdi5rWf$+Vi zRoM0=m`pdUXDz9G>HP&U$>LMx3Y=V2s4z$NDLyxIhINAzpm~rXuX|@t+`3pxYx5Cr%aA0G}eh@)o zVB6lT@INKOa@NR|0pqrG$>#?jhd*rc*5p=}nq7b)A0Yf9fr;A_XzD@S=R#y=nOT1qg+36^9*3 zuKh^afy+gD!n;1?kV$6A^~bam2+A1QV`XbBz7J6FQyN(ntFZBC<*)wsN|DVb@3l$n zs8}*2JITMp{C_qS#`881mMfoLDQM`YY2+{(f zYBPM;)7!sSI{S_FnmcI=0q!Y>f|bWF!_iDa1?Az`tR@x0O8?C32z7rV7pF`EZLBHY zvdb%TWr{G>6g@G81b(9U$)lS9Ppp_|P{9Ary5F{+-+GX1&6U;nd!X(CifV z2!?!wKx17ib??f)XR;JQ-@34m%(g(G6?R4-VjoR-`r;Spp+a1cqKy@=t-$XGwmz|8 zYp%4Y9ba;lW+*YQOO8LdC;KK5T^r)yQu{`B698=ZW*Xxk-i!YUQKd&fO z`fK1AdeR0T2j`2Qtwyy$nK!@MMx<537SmtR6sOC{{N@PIcDSCNdjaniE8)X2H|ClB z0YnBpuGkd2QKyq|Boe4CS?0aKmcuuEyMd<`ojPI>e`t~kTs)}x0&Rz1;N_L0emovA z#rtuX2IU&E!jSCVsT#EQ*|Tu}C5M{seY-)h8?>CBe5^=Y$PjbB)WU=DfOUyQCuq5S zf){|8!i2(b?qGkKwNlv`mQaWu6*s8m#5Z@2K@b^W^QAnau4%%lcl9FhF>Gn9c9*V^ z=IDhZQYIWFUQ+I+GGm=sb?Ls(N=>htfg!58DI< sY`@E(32s}xAEoL_!~UNu6@SL4sKn;`oSO5Jwj=}?>6_`*>$>9q2bVQVM*si- literal 0 HcmV?d00001 diff --git a/mkdocs.yml b/mkdocs.yml index 66c8505535..94bc1453de 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -251,6 +251,7 @@ nav: - Actions: xdr/features/automate/actions.md - Actions Library: - AWS: xdr/features/automate/library/aws.md + - Atlassian JIRA: xdr/features/automate/library/atlassian-jira.md - Azure Active Directory: xdr/features/automate/library/azure-active-directory.md - BinaryEdge's API: xdr/features/automate/library/binaryedge-s-api.md - Censys: xdr/features/automate/library/censys.md @@ -424,6 +425,7 @@ nav: - Actions: tip/features/automate/actions.md - Actions Library: - AWS: tip/features/automate/library/aws.md + - Atlassian JIRA: tip/features/automate/library/atlassian-jira.md - Azure Active Directory: tip/features/automate/library/azure-active-directory.md - BinaryEdge's API: tip/features/automate/library/binaryedge-s-api.md - Censys: tip/features/automate/library/censys.md