Skip to content

Commit f59fe68

Browse files
committed
Update tenant docs
1 parent c919c4f commit f59fe68

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

content/docs/core/concepts/tenant.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ keywords:
77
- Token Validation
88
---
99

10-
A tenant is a logical entity that validates tokens against configured identity providers.
10+
A tenant is like an identity broker, a logical entity that validates tokens against configured identity providers.
1111
Each tenant can have multiple unique providers configured to handle different authentication sources.
1212

1313
<Callout title="Caution" type="warn">
@@ -17,26 +17,26 @@ Each tenant can have multiple unique providers configured to handle different au
1717
</Callout>
1818

1919
**Tenant Provider**:
20+
2021
A tenant provider is equivalent to a single identity provider. For example, if you are using Google as an identity provider,
2122
you need to create a provider for Google.
2223

2324
### Illustration
2425

25-
Let's walk through an illustration of how a tenant validates tokens in a GitHub Actions workflow:
26+
Let's walk through an illustration of how a tenant validates tokens a typical user request workflow:
2627

27-
![github action](/images/github-actions.png)
28+
![github action](/images/tenant-illustration.png)
2829

29-
When a github action is triggered, it will validate the token against the tenant's provider.
3030
The workflow is as follows:
3131

32-
1. The GitHub Action requests a token from GitHub's token server.
33-
2. GitHub's token server issues a JWT token and returns it to the GitHub Action.
34-
3. The GitHub Action sends the JWT token to your server for validation.
35-
4. Your server forwards the JWT token to UseGrant for verification.
36-
5. UseGrant extracts the tenant details from the JWT token and checks for a matching configured provider.
37-
If a match is found, it fetches the provider's public key.
38-
6. UseGrant verifies the token's integrity by validating the signature, expiration, sub, aud and other security parameters.
39-
7. UseGrant returns the validation result with token expiration time to your server.
40-
8. If the token is valid, your server grants access to the GitHub Action, allowing the request to proceed.
41-
42-
This is a simple example illustrating how a tenant validates tokens in a GitHub Actions workflow. This logic will be the same for any other server.
32+
1. The user will request a token from token server or Identity provider.
33+
The token server issues a JWT token and returns it to the user
34+
2. The user now sends the JWT token to your server for validation.
35+
3. Your server sends a request with the JWT token to UseGrant for verification.
36+
4. UseGrant extracts the provider details from the JWT token and checks for a matching configured provider.
37+
If a match is found, it fetches the provider's public key from the provider's configuration and verifies the token's integrity by validating the signature, expiration, sub, aud and other security parameters.
38+
5. UseGrant returns the validation result with token expiration time to your server.
39+
6. If the token is valid, your server grants access to the user or generates a new temporary token for allowing the
40+
request to proceed.
41+
42+
This is a simple example illustrating how a tenant validates tokens in a typical workflow. This logic will be the same for any other server.

public/images/github-actions.png

-102 KB
Binary file not shown.
148 KB
Loading

0 commit comments

Comments
 (0)