From 7241ac3a50234582ddde0d6e9b92588a2086cb8f Mon Sep 17 00:00:00 2001 From: DacongDA Date: Mon, 19 Aug 2024 01:46:31 +0800 Subject: [PATCH] docs: Add docs for the new feature of accessKey and secretKey (#631) * docs: Add docs for the new feature of accessKey and secretKey * fix: fix format error * fix: move to public-api * fix: fix linter err --- docs/basic/public-api.md | 10 +++++++++- static/img/basic/user_api_key.png | Bin 0 -> 10781 bytes 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 static/img/basic/user_api_key.png diff --git a/docs/basic/public-api.md b/docs/basic/public-api.md index 668fcb811..56d95f0dd 100644 --- a/docs/basic/public-api.md +++ b/docs/basic/public-api.md @@ -109,7 +109,9 @@ We can use the access key and access secret for a Casdoor user to call `Casdoor #### How to authenticate? -1. HTTP `GET` parameter, the URL format is: +1. Create a pair of accessKey and accessSecret in account setting page. + +2. HTTP `GET` parameter, the URL format is: ```shell /page?accessKey=&accessSecret=" @@ -117,6 +119,12 @@ We can use the access key and access secret for a Casdoor user to call `Casdoor Demo site example: `https://door.casdoor.com/api/get-global-providers?accessKey=b86db9dc-6bd7-4997-935c-af480dd2c796/admin&accessSecret=79911517-fc36-4093-b115-65a9741f6b14` +![User Api Key](/img/basic/user_api_key.png) + +```bash +curl --location 'http://door.casdoor.com/api/user?accessKey=b86db9dc-6bd7-4997-935c-af480dd2c796&accessSecret=79911517-fc36-4093-b115-65a9741f6b14' +``` + ### 4. By `username` and `password` :::caution diff --git a/static/img/basic/user_api_key.png b/static/img/basic/user_api_key.png new file mode 100644 index 0000000000000000000000000000000000000000..65e44922003d830e9c4ec8d91cff0fd7f2792dc7 GIT binary patch literal 10781 zcmb`NcT`i~+UKJ*>Hb7Oy3z$g2?zoL(tDHMk&aXe9Rer_(m|T^q996dp%VciK&2n+y_b^iI> zfx8vk002*`mF1*$ea(00ES%{L(C3F0Cdh8@+on2-(FP-e&^r-SBP*jJA1({G@XjdS zdB8P!1^y!6u>byskGaI4XA3Vr%22zf564X5PCqt3}wB z{s6~cGXVe#P!yA3wt-1ppFg-(&l%L@JE~0DKM4y8{5ck{!lg z_Wj9!?ey=L@ryxZ|Lew3C==RWo7c=dH9F0}29skf>R;S`i^;AKYJ7%mfBJq%7h?A2&6^#Nnc^gN1oXbTN1No~U8?AxyPuL%^@L`yaaz7M zi#DT8q{{N$spa+a5mT!xEz5=h~F=-8=I%=o%Y)TlTXfior(egdBeNp zv=sKXH@+2~>A|h=8jydRsiLBOk^NjelTA{S%+!y5EBYWrVB@Uub;3Os<-T)lGu8RqTb3imOS1$3OYX*9Y3rku zx0`+ih+E{TT)Yi@Foj-6AlOc+dsee&nMTAqRLJIJfTT}%50Ao;gp`IuUcod?ZEux~ zMyzmI)Oh7^*=58v3n@yIy_?vs19Vl$iEDH~ZPu9=Tj$QZ$cA6l5Hi57I>nD1*rfov z1d(m79fSY?r)NN@f~#S8?d;cCb)R#Up`GHaXs>9S+-(wLMlrZX&-i5!1%WVcK+!BQ zP5!#$Pe*ZdEwz~L`51^3f)sgE!i_a*U5<+xY+BV^!vV_C$!&3 z@E4jY3i@8IP6>0FrN)X&0{}oj&C&`vb0^lLc>H*D(=F_B7Dt z*tfl|9Cz;dj0^^ttX z4OtFMX*FGYvDzP?Iuv*o(Z3%H1Xcf!zblBZ=GfjGNg5D8{ z_PEvDZ+IGC{zYVut3{PFRQe7;tA2Md&)dByMrrS|gE#V0aIW1jrqsx-81kd%0OM4gx)%8@LmDFu?N7xM#N7fjv@9LWV83SKF^lOt?=^Pd(-#=hGE}H~_91ulM07 zDm3DY$5KbwiQ7R*Ev;~^*YYS*#l7S$1CRf&Fyh)f07J2+5quD>O>aa7y?R z&v1XAv6@i7qOVXDT)oAfDK1vnI->quwMGY2v%sDq{#CH;{gA7Z5t$cM^-F2*?|F;l z)rpSX4=%p5T-E3;HrU#yehstKa2Catm)Z5jEeGI}b(%vFx>Vhw$P?cIWb(v;q+Fb) znP+;H_vt6oEU;ol+q2-(UFd^z1u>OWixbGNbBR~pc-K0H_+Dj-t3B@u?B|PcuOCRc z^`%;O2t+1ND)befG!|TYH?{}wqxL(HQT03?Sy53E9IO^ah4Cp|{y`ym?*>L-B4B-g z8&iJ~Pp5P8P|x?_KKUR6z5TnkeBF~a7VdYvsGE0f?}k)#U9(Mf2&csnWw#l zPOf-Cl;Wo`eMElDovO9UAjMd9?#7)ca*j7!KZb~iVl1g%rITVJLgl9CP&)d|#=~yc z;x+N2Qe9+3yXOt88rQxNqYU1G;Bz07>!v4-9La;om)6nY@_qHlDvt_qw7WKm8OKzZ zvZ(k3OY0CeluRX%tRtNt8k;3%u8o-_1-F(2Xr2A8=&Qz5xot-EM>cBd`AZ`c*o;j1 zQ`$Q(T|^|2Tp*t=9%bbp`y7M1zF^`}WK(-|%iipn9a!jS;?_%DKa+fwyQT@pqu5WH z*TPJY!s%!tvm|lXP2626gPIqihq?HWuCjF`Q$x>13yLX}H{#FrC&%v^<0LpuXjx-Q z?0#%h>_Wbi)RbZy8MsmImf(MGoiU;B8s%KU$1@w|!Q+zyM@*+K_dWCD{!U*q@|m1Q zW$3u+Ls!($apB~eoH4oolX7f-;mx55+7G31erG=CUWNx0B5t-Na#BW)KLk@*n7jbd zVE(!iyq#Hn&`*w0hU{zZ5DfWookU=)hiE=?3Su;dHG_3@P|N2A>XfTf#N`%mX-eFB z>r!s;{2Z%H<-g|^AiW2y&n#TM!-6_U%5=82j1Bn2)lw=Sm@XjPETrl#5#NgJRLxru zFeb{N0o5uM@hfv)Gj)f_vqr6?ihC*o72nm-L$}2ukFGo^bcj3Q*`m5 zzxVGq)_sz)mmz{SHqm>kvqq;{teC3h0g2n2))sTc{rg>fes-wY1dVv`_~kVJr22aQ zH>dhQiN~(REhfTgl|01#dxCZkuKC-^U_a@!FXhj@Q;bSUfs-doX?wx7%cr!IQ=X%hc?n z?)Mi%o2R)+&oN|%=}FPi>Z8-sj!X=*1D@`-D0Tuyajt7r%ZAwk^8m`J+M`5+cIAgD z5pT$1lmWL*#pcB9nYN>^;5@;e$>(&c%Tkkdr4nS;Vf~_6|8Z{WsTD+Y9A*)8Elp7y z;HGGzivGRiv9FkpZmi{0cMZs95bv)I9+~W0D=?i65b|x6MSvr%K|4*9wRSuMgFOQi zop=KW(5}a$GF7YwH@Dt3s|4p0y&a~-)f4VXx}7dxpUFNGPS-pFd$2ucMO}Zq_hF)| zXt2Zek;MGXQS8^gj-&0VZ7Md<9ZSDldarFpmjT#hx3}9&+yFn~X5zios^QfOzHc{g z$(xLkM}rf#k<=zR21Q;0OeBM`u~~4u{PO-PV*y97B3ebLID(wu9&Pa_LSoq&mnCw* z?p{jHw6^HFPj161Oa5Cr;I}LJZ|oNI4@4y%TyZyLV)@!*z$(x_bhZn}Ij-|B306gQabS}`}eJ>v3ie=gecu0dND;nDv&iL{cqw4cE zCrtaLoS?f!fddTrLC&)$xtOn0Q$f1MZhpBcrvkw1BX!g&bYFxtBJ+rxo>Rv!*;gv{ zY&(K0uRC<~jU*x87EuZ6+k(68+!X3BmxA-nCOVe^e#-i@FH9OlcZyo#rXVNW(ejSN zL=)5A3m>WJ%`Vk}!k^Jz#InM-n^5f;mq#ZSLs@hI*87!JbJ^V4qqPnbmk`d4uvAC> zTKI%ix+$^d1w=SwIpv_70o*csjG$`+Ouo<42~tA@8$600KeSq^_4$VA8eMRa#2 ze9(H=E{34%2>#|Z`@;;DCrnX!?|%F(p@~to7`7d;FRBKe6cFQ0JN81EQia{PY|N{# z7B4A+KHnQzmxDSoa=_K2dNSgzhwNij0Ji3uYw^*rsVGj!l!TB=3l5f79Xs| zDp~M2vkt&IcYZd+-qWild~m&YTCf?!qmbzteTcv6M?GFWTj9icMQ9+kNsvMCGca@)l2Td1StVMA`iJWTe>BlfOo!2uj^Pb4U^p=K1a(kkGuco9~fA%p)ni5v5 zr__*=+r|fsHhdoT`yymBwU-g*!TXl+dS|Mj8vfY7wBQ}1GIqXYZ7qbz(~W)H6q{MR39_I_4wOp$p2cjfP;`tV=Ax?Q@G?Iiy@pq%%zZ{#p;wgUYdb&v zUHxbVlEi=3J}hu=M04%+-c(ojhbfhYs8kM0KTIDz%zZn-jFAiGaM=tVaGQQ>O;psm zYCpk8g|h^FZ2nnEznmVCvwk+KG1l%edv}QdS`D8g<|^#&OQ!#5a`uAkL(YRGxXL{E zLSl1&a`n{{FXA7IlC;IT{5^t;Z8XRBO@-i{Ftus@dv5OQ!=)z0Wt2hNzkY>G0+$@N zKl*g?QP4Y!sO8j`PC->#6jFr2OtBNY;0NO)hnaNKnkJXT_U)vpo^)NVHV^&E8!LTw zlAHu@Uy4^q`TMzH13GaT#Z?ZBL5`ZlHHNoF#nr;ELVF}OA*zjO7Y^egEfcrlwJ;nx zcbX)ef2^F@Zgs9Ryt}P!haz~idSCnJ&!NA{^W_=4H>*48hs+z4iRET z$Q;2-Z1boB}DK5QzY;4@7I9WHH?f1=kV?Uw4P!2$EKz@x3{-Fw)HPi-Plz5zEB7* zxx`6=%WvQ7-TKuzpLyGUe1LAGc<7Ssq9V*ZSv4(fb!nAy8um>;j`2+;CU~7&-8I&e z2MFwqr4w-`CU}ia=@o~6n(Y=4QV-oOkvh&8anB3qFC_)E!uZ|)oz(YXdXN8O0sW+A z)BZ*(ER_r^IB46L`6T?b7)1>qv7U^h5l-AkbGhb;xhG7l&VZk09|dR|oE%jZp4%XG zSdNb8d1l~Cr(OXtVzZ*{jV3@yGr2U54;w?$VVCCqJ(=!0p9yRtdJ_>C=u?(`i&7dK z)X5EKK$Vva-2ouY?$J)QAS*rXL8A~m)WC3gN{mhai)-IEqnQ!{kJGI??HoT2B1k@( zupD&HZjWB3Gq|d(Xg1o4PXA`LfOysi9;>P!89IgDtoBu#6#?m*%E_pJmgi+A;b2!< zz`;9a2TO1*Gv+A4vn4AjQU_=kE)ryYa*@2^A$t7zQ+v83&1e4Trhr0wZ{5KUTe{E z!)t>ZDg$1(@q{YkyKHCyM=@&gF|Yy`Dzl>#$HaVU^jY+uG@6|w?s8jU_eb+2I{BNm zV4Jvyy!nfb1LD^$G5E_)2nQ$AEi4O?O!v?6Ci(bieQ3*=)nzFZXHHa76 zmPkpBxafWxmo#NW6~(Bq_rx|=`k$PYfI{}CY`~jUCb#m&?=4bmsjJh=*Q<$IPT|H4 zRlE}Men3WSg9)T@^tS!{Mty=J6tc{b}S5H{5^e^49vdWdXJ%g5(C_Qo;X-iG_8Cv<#BdMNO-bI91(wS zGUX`Ll_rBG`CBwHLUup0%GcWLb_YN3D(EazUKI1q2brumIYQ^dhGI)@&jYwC{v}kY z%v+8kgN@rT zNtzXj?2LNd0r)WOkwl4GzQPB|dR)j{N@s}uJnmgI#R^`poAB`aE~g7rD**R%W`_kF zkxN~LD;qhFA&&T=k7Jej7Cx;)^;Q@IF~gIOgw&20?Pq|WYxji?+D9_Mn<84CmBmue z9|8^%75;|iUh{MQcObj}BH{bz)8E`$H{{|>R#>E&HG4NcwcIu~HvU8>;@Wd{)x>)9 z0|4m5s%gUiP30@AtH+uU0j4;cG(vD`K|+>0(>02FFieolpTP1*i~B@EZJg)Z<_7Kn zbfd8cHa?TM3;+PmjM6wCM-FMk*l_@re%N5909O>mZo88I2YR_Um^YP$oyx&}N@C`N zy~J~_s0d_9MH?3Z8NIs>T@|}QaIp58KGH_XY+GB@!!q;IQQ7XBolSctaDX9u6t%$~ zQ&*C(^-GP}QH9~v zqv>5dyy`^A$SxKEknYx$H*=~dqI<`Vt&PbP<4smti(}I?S6ajRBs>_64?$ez8=|I_ zxou%C&C9JUhxFX~3YYV+YM5ISADC1=7{*K##9_5_-DET(+Ng&e(NB{!ZC6T9dKykt z_AYrv&O6JF@)CcV^QWyQv~v1WOMvyfsD~WzZ1{%V_K10dy!|h=YDY=+8k8v^T5o^J zs@O<|6~-rK z|55nj)KYf6OS4L;6?sWqUT(0HgI_pSOMb6XOOoq3!o*~UJ|IX5rE6n+{gP+vttyst zqq{7(KzP1gO{&KS)#^lOH3^Sqpcf!AC)CtU7M$k&UG+My(nRudop12pW3l6lvf_%1vlHPcYLkwd z3o6|KH1nX z7IK3)ijH_50LJ64Mim=|@dp?A!IBo{4ym$-{9lgUo~eR&fGNBz;BH`rLSOs!oVc;@ z231Y|JRuOiYiBXXs>0%s=l`#$I0yyo8Ka6<>kcOQ?6BmJrphnHGG~9YK8QG|8V2VO zuFs^J%5MKe7zZ(w*MqK0QXpS$rgH*YRY}?-}PCuY{u53 zvRB=t9OO*orqwy{!}QwVNSo6uhFQ9rhm_>@8usveU_HZg=4^Q>vrP9fqZV5w?kN=@ zFqJ48tFjU3&zv`sQS|VaJM?7AyyD=vo8Muwg0S|1LrOlD{g%0_fl%5W5>A~bw;EK z2QfH5I$M7$6J1PiXMSA}tes8jU2wPDE8o;9oK%isO(#c~BQv_LjJ_7sz&Uxwn4+QM zxb?-l!epKod|e1xTx5Sssx-T8+ZEVE!WBlk+gySxX<}!wtis5`p)0!iJU!Nn&tYTq zEgm*W+nIV@WItezVl>Cw-qpEW8hNa3&*ecH7SyN^8gKmhX|=QC2(;W6K0?2q*TVHY zB0B7#u4D`<{;gX7ql?FaKt-KmbBfrr7(^7ZR787qi|w4TpM{EbXTQ@bDS&D163aaB zVAQHLf*v)e{BvxSj~(*F*m+1C>m#KAwao_pc8aT6^N^*~_^@u5+N>?=?2N#-N-HNH zPwZPR*^87g->HtXz#y?%me8x3-^}Qtlb#FiOa0jN;4AGS)h3xx&FBHl0vn_Nl&cnB z+c&UqR}xq)GQaU7cWS3=5XR3d%<7$}TUaI0kmv2qm@;7^m=Y2Dd!Uxr7x*MXc6G$} zC;1(7`Pb*WHOymct%}|*uekNzEY-AYKHtORX#EnFFJojb7la_&-g_)NeF6w_bF+>_(fXi$bk7-u_64FY!JpS?t zTSg&n;<@VA)ekrK%zrEnoIdLuT~q(iud3giEwvaCc^{%-lezZR1Nrr1sb4A~!}_T_wB4>1ZG6z3*1W!zzxnurQ$)U>!yDs4`CVvcTja%HKB$QK(ix9h z53Wy!r88&0tLIpQ3Y{6{-!#;vY+UoGAmD*Qv4LE1G3or*s2QFTw>H}}Cm7^lW-Xtu z;`qmR-1h>6wsG2q*3E>H>@t_Y$1@eV^SK@R?^|46<#sdS310^_)M-%N;OZ=0$Qc)@ z;4x9~h%uX~=2LMVSBA35_T_fYK-jAH-?>Nf_Led<7zI{(tQJVaoD+&m(iryOpK8@g z9Dz7kI{7&bY;Ckj*u;%o?#Qc+%|7jZU7MaDP}2USTz*EZ19<<*Ro0nwI+2?W)B5#5 zO>#Jq8|vdpSBJvr4SCKkPJ9fG(kCJF$G^zbkR0SizlBV!+#T}2_O*Z1?K7@og{6&J zYpWDHDbZi7*PzexC*9mm`h-T+zdp;)o`{++SvU?=Pk~BO5_@8MtM>I1P#{O4-o&5& z*BWjpGex|n*AqCgl{xk2pv<0myWYc2<@JLf(3q~ZP5(7mpik`iGd*#$Hou}_1zFjt zttf@Q>K#j~;G4v`$s6CV9zYip25FoWuo?Y7m1V?=I?zb!A1CWWB(wLe;NTaN)K{r} zUrDwtwIFdM$`<_mLe8)7WoF+vozJR74ZtW=^i2JrQcVs9VQ~UeJ@w+kcDq}@hdD%b zjBdQjE4>OHmeK2bD?!rFb(86?`5Bt-^QA+K#~|sXJ`%qB&4csxO$6#G4})?p*U3*@Fu0!XNuz^3_WsMJ@!W1+TLMM82n3_%blqJbDwM(WDs;pVb%%(B1I1I=@$G zK}s?g^7PQojBBwmb#U?>n67OjQ>ADD^_Li5@GJ@7?co0X>A?fu(4O00 zaXQWxU)EpM2xStXi(s0GE*XV{>y>R01tOWm$hN4hx`gSOe$9fR)YCbBx))g?AmHbYvo+S4z;{E!@%}vvs{aS0IrtR0`#?l@`3kN#w|5M4F zXV&)bC39`S&t3W9m#bL6!MSNf%!cEhC?}D0zgNmQWWrvw%I2HlIo(X^hfy zT#`CnT<1V*7*Q6GIBRyki=&USxA67^=Wf14-BG;ABvKc}1V$X~9HNhuil4~>k%nnG z@D?g^>;sh@e(5FT+`vmJy4j&H``XcoDfy|m)XDRCKA@G1LNg&99fEN5C^9b3iS?** zj%yXNOWeE)Ckz$GY>&)ET6kq&&8i3B@cqwMgMH~Z{LfxCFbT#Z2x&e^iZ}@VkY|)a zu`hGT;wXYUL0S9>V_VpwMb+>{9MPtP0F_%QB6luCbABkOhI1Wr5|??jA?Cka?%_j- z2hfend)HUTkeZ$plol>>F-Dg#&5U068n&|^p35hf;;GHbNccV`cv+sp7ym}%X@RPF z1OFp`28icud)|-L@jO!I#oY+U|HK69nSAiO6f>|z@X@bH7ym*65*Xj(OCAY1Z%mr; z4U|n`Qpl(ztUB=K*Z>K;s4!(l#zjXw735AbbHcvvfRv-h||^4QP~yM@^ruT zJcl()#Y6?m8IV5nkZNl4Ev&C)a+aRwD4C+^9!$(2G)x)5X>JiZ0 zkTUGZiE{iyEU*{@J|LZy8k?G!N(peb#flO&xXo~#e$GD~APCy}Op;t=`_&c?U_v8} zLpdfLAJfaJiEtU}YIZ+cek9VR?y2R*WY$Hr z?MMvmJ4ZSXSug=ApW>1t>$)}1BC~pxdF>gg@om>^B(oeiH~y^YO=?U-YKY;__5FR> zNt??$sA^;~2{ay&5I5g*f{=5S^Z%-j&-dAO{kpKLlyM$4zDctg5LJ8!kSUMFz$NRe zgquSRgcSGjh{meYlNZY$a7(W7Xhipd^zG2p8kedje+);TvSXosE0nGk z*hzL0lU=BX0}zhPdq*A%Jrh3H!8)X7S1P59!h(pq_K7wF%ME+9nj~DLdn%vEXOIpf9h6r@Mzu?~ohUuaFv{%0aJY(547Zyb;`Q_l?AX6| z*rX6OR!*6iuam!f2jEKl9)B-{YEw#(^T_nucF}Y0R=)EFTR(}Sqy6J%kj7xo!UyWF z2;jEABnJzF?C2(6aG{8hLZ>q(Jx9wxDOb%W%tWYZWpj+(Fs#jM)Z-0vlLX|?JQOZl zlOha;UtOJUS36Deir~q$UTu{eeb*>%X*fp(Tuu;%0OP&Qbh|LM8n(2n1SCMZK0JWK n2-djxv_Ss<(#rTC5kqciCSscuxXzBf5TGotAy+PA`Tl