Skip to content

Commit d6044aa

Browse files
committed
Add missing endpoints
1 parent 5e7c938 commit d6044aa

File tree

226 files changed

+15047
-1485
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

226 files changed

+15047
-1485
lines changed

docs/index.mdx

+18-6
Original file line numberDiff line numberDiff line change
@@ -142,12 +142,24 @@ import { DescriptionText } from "/src/components/DescriptionText";
142142
</ReferenceCard.Description>
143143
</ReferenceCard>
144144
<ReferenceCard.GridHelper />
145-
<ReferenceCard href="/docs/references/api-reference">
146-
<ReferenceCard.Title>
147-
API Reference
148-
</ReferenceCard.Title>
145+
<ReferenceCard href="/docs/references/fdi/introduction">
146+
<ReferenceCard.Title>
147+
FDI Reference
148+
</ReferenceCard.Title>
149149
<ReferenceCard.Description>
150-
Information on the APIs exposed by the SuperTokens Core and by the backend SDKs.
150+
Details about the endpoints exposed by the **Frontend Driver Interface**.
151+
This is the API enabled by the backend SDKs.
151152
</ReferenceCard.Description>
152-
</ReferenceCard>
153+
</ReferenceCard>
154+
155+
<ReferenceCard href="/docs/references/cdi/introduction">
156+
<ReferenceCard.Title>
157+
CDI Reference
158+
</ReferenceCard.Title>
159+
<ReferenceCard.Description>
160+
Details about the endpoints exposed by the **Core Driver Interface**.
161+
This is the API enabled by the SuperTokens Core Service.
162+
</ReferenceCard.Description>
163+
</ReferenceCard>
164+
153165
</ReferenceCard.Grid>

docs/references/backend-sdks/api-overrides.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -632,7 +632,7 @@ init(
632632
</BackendTabs>
633633

634634
:::info Important
635-
You then need to define your own routes that handle this API call. You can see the [Frontend driver interface API spec here](/docs/references/api-reference)
635+
You then need to define your own routes that handle this API call. You can see the [Frontend driver interface API spec here](/docs/references/fdi/introduction)
636636
:::
637637

638638

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: get Check account linking possibility
2+
title: Check account linking possibility
3+
sidebar_label: get Check account linking possibility
34
sidebar_position: 1
45
description: >-
56
Check if accounts can be linked for given primary and recipe user id
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/recipe/accountlinking/user/link/check" title="/appid-<appId>/recipe/accountlinking/user/link/check" />
11+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/recipe/accountlinking/user/link/check" title="/appid-{appId}/recipe/accountlinking/user/link/check" />
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: get Check primary user creation possibility
3-
sidebar_position: 1
2+
title: Check primary user creation possibility
3+
sidebar_label: get Check primary user creation possibility
4+
sidebar_position: 2
45
description: >-
56
Check if primary user can be created for given user id
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/recipe/accountlinking/user/primary/check" title="/appid-<appId>/recipe/accountlinking/user/primary/check" />
11+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/recipe/accountlinking/user/primary/check" title="/appid-{appId}/recipe/accountlinking/user/primary/check" />
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: post Link user accounts together
3-
sidebar_position: 1
2+
title: Link user accounts together
3+
sidebar_label: post Link user accounts together
4+
sidebar_position: 3
45
description: >-
56
Link accounts for given primary and recipe user id
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="post" path="/appid-<appId>/recipe/accountlinking/user/link" title="/appid-<appId>/recipe/accountlinking/user/link" />
11+
<APIRequestPage apiName="cdi" method="post" path="/appid-{appId}/recipe/accountlinking/user/link" title="/appid-{appId}/recipe/accountlinking/user/link" />
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: post Create primary user account
3-
sidebar_position: 1
2+
title: Create primary user account
3+
sidebar_label: post Create primary user account
4+
sidebar_position: 4
45
description: >-
56
Create a primary user for given user id
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="post" path="/appid-<appId>/recipe/accountlinking/user/primary" title="/appid-<appId>/recipe/accountlinking/user/primary" />
11+
<APIRequestPage apiName="cdi" method="post" path="/appid-{appId}/recipe/accountlinking/user/primary" title="/appid-{appId}/recipe/accountlinking/user/primary" />
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: post Unlink user accounts
3-
sidebar_position: 1
2+
title: Unlink user accounts
3+
sidebar_label: post Unlink user accounts
4+
sidebar_position: 5
45
description: >-
56
Unlink accounts for given recipe user id
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="post" path="/appid-<appId>/recipe/accountlinking/user/unlink" title="/appid-<appId>/recipe/accountlinking/user/unlink" />
11+
<APIRequestPage apiName="cdi" method="post" path="/appid-{appId}/recipe/accountlinking/user/unlink" title="/appid-{appId}/recipe/accountlinking/user/unlink" />
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: delete Delete license key
3-
sidebar_position: 1
2+
title: Delete license key
3+
sidebar_label: delete Delete license key
4+
sidebar_position: 24
45
description: >-
56
Delete license key
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="delete" path="/appid-<appId>/ee/license" title="/appid-<appId>/ee/license" />
11+
<APIRequestPage apiName="cdi" method="delete" path="/appid-{appId}/ee/license" title="/appid-{appId}/ee/license" />
+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: delete Delete hello message
3-
sidebar_position: 1
2+
title: Delete hello message
3+
sidebar_label: delete Delete hello message
4+
sidebar_position: 23
45
description: >-
56
Return a simple hello message
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="delete" path="/appid-<appId>/<tenantId>/hello" title="/appid-<appId>/<tenantId>/hello" />
11+
<APIRequestPage apiName="cdi" method="delete" path="/appid-{appId}/{tenantId}/hello" title="/appid-{appId}/{tenantId}/hello" />
+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: get Get API version
3-
sidebar_position: 1
2+
title: Get API version
3+
sidebar_label: get Get API version
4+
sidebar_position: 6
45
description: >-
56
Get a list of compatible CDI versions
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/apiversion" title="/appid-<appId>/apiversion" />
11+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/apiversion" title="/appid-{appId}/apiversion" />

docs/references/cdi/core/get-config.mdx

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: get Get config file path
3-
sidebar_position: 1
2+
title: Get config file path
3+
sidebar_label: get Get config file path
4+
sidebar_position: 15
45
description: >-
56
Get path to the loaded config file
67
page_type: api-reference
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: get Get enterprise features
3-
sidebar_position: 1
2+
title: Get enterprise features
3+
sidebar_label: get Get enterprise features
4+
sidebar_position: 7
45
description: >-
56
Get a list of the enabled enterprise features
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/ee/featureflag" title="/appid-<appId>/ee/featureflag" />
11+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/ee/featureflag" title="/appid-{appId}/ee/featureflag" />
+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: get Get license key
3-
sidebar_position: 1
2+
title: Get license key
3+
sidebar_label: get Get license key
4+
sidebar_position: 8
45
description: >-
56
Retrieve license key
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/ee/license" title="/appid-<appId>/ee/license" />
11+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/ee/license" title="/appid-{appId}/ee/license" />
+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: get Get hello message
3-
sidebar_position: 1
2+
title: Get hello message
3+
sidebar_label: get Get hello message
4+
sidebar_position: 2
45
description: >-
56
Return a simple hello message
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/<tenantId>/hello" title="/appid-<appId>/<tenantId>/hello" />
11+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/{tenantId}/hello" title="/appid-{appId}/{tenantId}/hello" />
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: get Get requests stats
3-
sidebar_position: 1
2+
title: Get requests stats
3+
sidebar_label: get Get requests stats
4+
sidebar_position: 10
45
description: >-
56
Get requests stats for last 24 hours
67
@@ -11,4 +12,4 @@ page_type: api-reference
1112
hide_title: true
1213
---
1314

14-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/requests/stats" title="/appid-<appId>/requests/stats" />
15+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/requests/stats" title="/appid-{appId}/requests/stats" />

docs/references/cdi/core/get-root.mdx

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: get Get hello message on root path
2+
title: Get hello message on root path
3+
sidebar_label: get Get hello message on root path
34
sidebar_position: 1
45
description: >-
56
Return a simple hello message
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/<tenantId>/" title="/appid-<appId>/<tenantId>/" />
11+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/{tenantId}/" title="/appid-{appId}/{tenantId}/" />
+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: get Get telemetry ID
3-
sidebar_position: 1
2+
title: Get telemetry ID
3+
sidebar_label: get Get telemetry ID
4+
sidebar_position: 11
45
description: >-
56
Returns the telemetryID if it exists
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/telemetry" title="/appid-<appId>/telemetry" />
11+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/telemetry" title="/appid-{appId}/telemetry" />
+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: get Get user ID
3-
sidebar_position: 1
2+
title: Get user ID
3+
sidebar_label: get Get user ID
4+
sidebar_position: 12
45
description: >-
56
Get user id from email or phone number
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/user/id" title="/appid-<appId>/user/id" />
11+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/user/id" title="/appid-{appId}/user/id" />
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: get Get search tags
3-
sidebar_position: 1
2+
title: Get search tags
3+
sidebar_label: get Get search tags
4+
sidebar_position: 13
45
description: >-
56
Retrieve available tags for search
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/user/search/tags" title="/appid-<appId>/user/search/tags" />
11+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/user/search/tags" title="/appid-{appId}/user/search/tags" />
+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: get Get user ID mapping
3-
sidebar_position: 1
2+
title: Get user ID mapping
3+
sidebar_label: get Get user ID mapping
4+
sidebar_position: 9
45
description: >-
56
Retrieve a UserIdMapping
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/recipe/userid/map" title="/appid-<appId>/recipe/userid/map" />
11+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/recipe/userid/map" title="/appid-{appId}/recipe/userid/map" />
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: get Get users by account info
3-
sidebar_position: 1
2+
title: Get users by account info
3+
sidebar_label: get Get users by account info
4+
sidebar_position: 4
45
description: >-
56
Get users by email, phoneNumber or thirdParty info
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/<tenantId>/users/by-accountinfo" title="/appid-<appId>/<tenantId>/users/by-accountinfo" />
11+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/{tenantId}/users/by-accountinfo" title="/appid-{appId}/{tenantId}/users/by-accountinfo" />
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: get Get active users count
3-
sidebar_position: 1
2+
title: Get active users count
3+
sidebar_label: get Get active users count
4+
sidebar_position: 14
45
description: >-
56
Get number of active users.
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/users/count/active" title="/appid-<appId>/users/count/active" />
11+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/users/count/active" title="/appid-{appId}/users/count/active" />
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: get Get users count
3-
sidebar_position: 1
2+
title: Get users count
3+
sidebar_label: get Get users count
4+
sidebar_position: 5
45
description: >-
56
Get number of users.
67
@@ -10,4 +11,4 @@ page_type: api-reference
1011
hide_title: true
1112
---
1213

13-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/<tenantId>/users/count" title="/appid-<appId>/<tenantId>/users/count" />
14+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/{tenantId}/users/count" title="/appid-{appId}/{tenantId}/users/count" />
+4-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: get Get users
3-
sidebar_position: 1
2+
title: Get users
3+
sidebar_label: get Get users
4+
sidebar_position: 3
45
description: >-
56
Get users.
67
@@ -10,4 +11,4 @@ page_type: api-reference
1011
hide_title: true
1112
---
1213

13-
<APIRequestPage apiName="cdi" method="get" path="/appid-<appId>/<tenantId>/users" title="/appid-<appId>/<tenantId>/users" />
14+
<APIRequestPage apiName="cdi" method="get" path="/appid-{appId}/{tenantId}/users" title="/appid-{appId}/{tenantId}/users" />

docs/references/cdi/core/get-well-known-jwks-json.mdx

-10
This file was deleted.
+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: post Post hello message
3-
sidebar_position: 1
2+
title: Post hello message
3+
sidebar_label: post Post hello message
4+
sidebar_position: 16
45
description: >-
56
Return a simple hello message
67
page_type: api-reference
78
hide_title: true
89
---
910

10-
<APIRequestPage apiName="cdi" method="post" path="/appid-<appId>/<tenantId>/hello" title="/appid-<appId>/<tenantId>/hello" />
11+
<APIRequestPage apiName="cdi" method="post" path="/appid-{appId}/{tenantId}/hello" title="/appid-{appId}/{tenantId}/hello" />

0 commit comments

Comments
 (0)