Skip to content

Commit 7da740c

Browse files
committed
refresh token and instrospect flow chart added
1 parent 8eef775 commit 7da740c

20 files changed

Lines changed: 64 additions & 24 deletions

components/image-switcher.tsx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,16 @@ const ImageSwitcher = ({
99
}) => {
1010
return (
1111
<div className="relative flex flex-1 h-full w-full aspect-auto">
12-
<img src={darkSrc} alt={alt} className="hidden dark:block" />
13-
<img src={lightSrc} alt={alt} className="block dark:hidden" />
12+
<img
13+
src={darkSrc}
14+
alt={alt}
15+
className="hidden dark:block object-contain"
16+
/>
17+
<img
18+
src={lightSrc}
19+
alt={alt}
20+
className="block dark:hidden object-contain"
21+
/>
1422
</div>
1523
);
1624
};

content/architectural-resource/admin-login.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
22
title: Admin Login
3-
description: Admin Login
3+
description: This is the admin login flow chart
44
---
55

66
import ImageSwitcher from "@/components/image-switcher";
77

8-
This is the diagram for the admin login process:
9-
108
<ImageSwitcher
119
lightSrc="/img/flow-charts/2-admin-login-transparent-light.png"
1210
darkSrc="/img/flow-charts/2-admin-login-transparent.png"

content/architectural-resource/create-api-user.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
22
title: Create API User
3-
description: Create API User
3+
description: This is the create API user flow chart
44
---
55

66
import ImageSwitcher from "@/components/image-switcher";
77

8-
This is the diagram for the API user creation process:
9-
108
<ImageSwitcher
119
lightSrc="/img/flow-charts/3-create-admin-user-transparent-light.png"
1210
darkSrc="/img/flow-charts/3-create-admin-user-transparent.png"

content/architectural-resource/index.mdx

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@ import { Step, Steps } from "fumadocs-ui/components/steps";
1010
<Steps>
1111
<Step>
1212

13-
### Resource Initialization
13+
### [Resource Initialization](/architectural-resource/resource-initialization)
1414

1515
On startup of the Shield server, the resource initialization process is triggered.
1616

1717
</Step>
1818
<Step>
1919

20-
### Admin Login
20+
### [Admin Login](/architectural-resource/admin-login)
2121

2222
Once the will reach healthy state then Admin Login api can be used for creation of the API Key.
2323

2424
</Step>
2525
<Step>
2626

27-
### Create API User
27+
### [Create API User](/architectural-resource/create-api-user)
2828

2929
For any client related operations Like login, logout, password reset, etc. the
3030
API user is required. There can be more than one API user for a client and each
@@ -33,16 +33,32 @@ API user can have different role.
3333
</Step>
3434
<Step>
3535

36-
### Signup user
36+
### [Signup user](/architectural-resource/signup-user)
3737

3838
An API user can create or register a new user to its own client.
3939

4040
</Step>
4141
<Step>
4242

43-
### Non Admin Login
43+
### [Non Admin Login](/architectural-resource/non-admin-login)
4444

4545
Regular (Non Admin) user can login to the client at this API endpoint.
4646

47+
</Step>
48+
<Step>
49+
50+
### [Refresh Token](/architectural-resource/refresh-token)
51+
52+
Refresh token is used to refresh the session and generate a new set of token
53+
so that the user can continue to use the client without having to login again.
54+
55+
</Step>
56+
<Step>
57+
58+
### [Introspection](/architectural-resource/introspection)
59+
60+
Introspection is used to get the current state of the token. Currently, we
61+
support only the access_token introspection.
62+
4763
</Step>
4864
</Steps>
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Introspection
3+
description: This is the introspection flow chart
4+
---
5+
6+
import ImageSwitcher from "@/components/image-switcher";
7+
8+
<ImageSwitcher
9+
lightSrc="/img/flow-charts/7-introspection-transparent-light.png"
10+
darkSrc="/img/flow-charts/7-introspection-transparent.png"
11+
alt="Introspection Flow Chart"
12+
/>

content/architectural-resource/meta.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
"admin-login",
88
"create-api-user",
99
"signup-user",
10-
"non-admin-login"
10+
"non-admin-login",
11+
"refresh-token",
12+
"introspection"
1113
]
1214
}

content/architectural-resource/non-admin-login.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
22
title: Non-Admin Login
3-
description: Non-Admin Login
3+
description: This is the non-admin login flow chart
44
---
55

66
import ImageSwitcher from "@/components/image-switcher";
77

8-
Here is the diagram for the non-admin login process:
9-
108
<ImageSwitcher
119
lightSrc="/img/flow-charts/5-non-admin-login-transparent-light.png"
1210
darkSrc="/img/flow-charts/5-non-admin-login-transparent.png"
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Refresh Token
3+
description: This is the refresh token flow chart
4+
---
5+
6+
import ImageSwitcher from "@/components/image-switcher";
7+
8+
<ImageSwitcher
9+
lightSrc="/img/flow-charts/6-refresh-token-transparent-light.png"
10+
darkSrc="/img/flow-charts/6-refresh-token-transparent.png"
11+
alt="Refresh Token Flow Chart"
12+
/>

content/architectural-resource/resource-initialization.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
22
title: Resource Initialization
3-
description: Resource Initialization
3+
description: This is the resource initialization flow chart
44
---
55

66
import ImageSwitcher from "@/components/image-switcher";
77

8-
This is the diagram for the resource initialization process:
9-
108
<ImageSwitcher
119
lightSrc="/img/flow-charts/1-shield-start-transparent-light.png"
1210
darkSrc="/img/flow-charts/1-shield-start-transparent.png"

content/architectural-resource/signup-user.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
22
title: Signup User
3-
description: Signup User
3+
description: This is the signup user flow chart
44
---
55

66
import ImageSwitcher from "@/components/image-switcher";
77

8-
This is the diagram for the user signup process:
9-
108
<ImageSwitcher
119
lightSrc="/img/flow-charts/4-signup-user-transparent-light.png"
1210
darkSrc="/img/flow-charts/4-signup-user-transparent.png"

0 commit comments

Comments
 (0)