Skip to content

Commit 8eef775

Browse files
committed
architectural resource home page added
1 parent 06621e5 commit 8eef775

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Architectural Resource
3+
description: Here you will find the architectural resource for the shield-auth project.
4+
---
5+
6+
import { Step, Steps } from "fumadocs-ui/components/steps";
7+
8+
## Resources
9+
10+
<Steps>
11+
<Step>
12+
13+
### Resource Initialization
14+
15+
On startup of the Shield server, the resource initialization process is triggered.
16+
17+
</Step>
18+
<Step>
19+
20+
### Admin Login
21+
22+
Once the will reach healthy state then Admin Login api can be used for creation of the API Key.
23+
24+
</Step>
25+
<Step>
26+
27+
### Create API User
28+
29+
For any client related operations Like login, logout, password reset, etc. the
30+
API user is required. There can be more than one API user for a client and each
31+
API user can have different role.
32+
33+
</Step>
34+
<Step>
35+
36+
### Signup user
37+
38+
An API user can create or register a new user to its own client.
39+
40+
</Step>
41+
<Step>
42+
43+
### Non Admin Login
44+
45+
Regular (Non Admin) user can login to the client at this API endpoint.
46+
47+
</Step>
48+
</Steps>

0 commit comments

Comments
 (0)