Skip to content

Commit 7fd5686

Browse files
Added Table of Contents (#191)
* removed API limits and included table of contents * added changes * Fix object name in readme --------- Co-authored-by: guyp-descope <[email protected]>
1 parent 945f19d commit 7fd5686

File tree

1 file changed

+35
-4
lines changed

1 file changed

+35
-4
lines changed

README.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,40 @@ descope_client = DescopeClient()
3030
descope_client = DescopeClient(project_id="<Project ID>")
3131
```
3232

33-
## Usage
33+
## Authentication Functions
3434

35-
Here are some examples how to manage and authenticate users:
35+
These sections show how to use the SDK to perform various authentication/authorization functions:
36+
37+
1. [OTP Authentication](#otp-authentication)
38+
2. [Magic Link](#magic-link)
39+
3. [Enchanted Link](#enchanted-link)
40+
4. [OAuth](#oauth)
41+
5. [SSO/SAML](#ssosaml)
42+
6. [TOTP Authentication](#totp-authentication)
43+
7. [Passwords](#passwords)
44+
8. [Session Validation](#session-validation)
45+
9. [Roles & Permission Validation](#roles--permission-validation)
46+
10. [Logging Out](#logging-out)
47+
48+
## API Managment Function
49+
50+
These sections show how to use the SDK to perform permission and user management functions. You will need to create an instance of `DescopeClient` by following the [Setup](#setup-1) guide, before you can use any of these functions:
51+
52+
1. [Manage Tenants](#manage-tenants)
53+
2. [Manage Users](#manage-users)
54+
3. [Manage Access Keys](#manage-access-keys)
55+
4. [Manage SSO Setting](#manage-sso-setting)
56+
5. [Manage Permissions](#manage-permissions)
57+
6. [Manage Roles](#manage-roles)
58+
7. [Query SSO Groups](#query-sso-groups)
59+
8. [Manage Flows](#manage-flows)
60+
9. [Manage JWTs](#manage-jwts)
61+
62+
If you wish to run any of our code samples and play with them, check out our [Code Examples](#code-examples) section.
63+
64+
If you're performing end-to-end testing, check out the [Utils for your end to end (e2e) tests and integration tests](#utils-for-your-end-to-end-e2e-tests-and-integration-tests) section. You will need to use the `DescopeClient` object created under [Setup](#setup-1) guide.
65+
66+
For rate limiting information, please confer to the [API Rate Limits](#api-rate-limits) section.
3667

3768
### OTP Authentication
3869

@@ -791,9 +822,9 @@ pending_ref = resp["pendingRef"]
791822
# Note 2: In case of testing sign-in / sign-up operations with test users, need to make sure to generate the code prior calling the sign-in / sign-up operations.
792823
```
793824

794-
## API Rate limits
825+
## API Rate Limits
795826

796-
Handle API rate limits by comparing the exception to the APIRateLimitExceeded exception, which includes the RateLimitParameters map with the key "Retry-After." This key indicates how many seconds until the next valid API call can take place. More information on Descope's rate limit is covered here: [Descope rate limit reference page](https://docs.descope.com/rate-limit)
827+
Handle API rate limits by comparing the exception to the APIRateLimitExceeded exception, which includes the RateLimitParameters map with the key "Retry-After." This key indicates how many seconds until the next valid API call can take place.
797828

798829
```python
799830
try:

0 commit comments

Comments
 (0)