docs: Add docs for the new feature of accessKey and secretKey

casdoor · Aug 18, 2024 · 4990d5b · 4990d5b
1 parent 5332e4e
commit 4990d5b
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/docs/user/api-key.md b/docs/user/api-key.md
@@ -0,0 +1,21 @@
+---
+title: Api Key
+description: Access api with api key
+keywords: [user, api key, accessKey, accessSecret]
+authors: [DacongDA]
+---
+
+## Access api with api key
+
+You can access casdoor api with accessKey and accessSecret of user. 
+
+1. Create a pair of accessKey and accessSecret in account setting page.
+2. Put accessKey and accessSercet in into the http query param.
+
+## Example
+
+![User Api Key](/img/user/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'
+```
diff --git a/sidebars.js b/sidebars.js
@@ -332,6 +332,7 @@ module.exports = {
         "user/multi-factor-authentication",
         "user/roles",
         "user/permissions",
+        "user/api-key",
       ],
     },
     {

diff --git a/static/img/user/user_api_key.png b/static/img/user/user_api_key.png