Skip to content

Commit 95aaa31

Browse files
dmoernerdmoerner
authored
Merge pull request #86 from clerk/update-openapi-specs-20260205-121000
chore: Update OpenAPI Specs
2 parents 27ae697 + 6c5c38a commit 95aaa31

File tree

5 files changed

+188
-4
lines changed

5 files changed

+188
-4
lines changed

‎bapi/2021-02-05.yml‎

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1463,6 +1463,28 @@ paths:
14631463
example: 1700690400000
14641464
schema:
14651465
type: integer
1466+
- name: provider
1467+
in: query
1468+
schema:
1469+
type: string
1470+
description: |-
1471+
Returns users with external accounts for the specified OAuth provider.
1472+
Must be used in combination with the `provider_user_id` parameter.
1473+
For example, use `provider=oauth_google&provider_user_id=12345` to retrieve a user with Google provider user ID 12345.
1474+
required: false
1475+
- name: provider_user_id
1476+
in: query
1477+
schema:
1478+
type: array
1479+
items:
1480+
type: string
1481+
description: |-
1482+
Returns users with the specified provider user IDs for a specific provider.
1483+
Must be used in combination with the `provider` parameter.
1484+
For example, use `provider=oauth_google&provider_user_id=12345` to retrieve a user with Google provider user ID 12345.
1485+
Accepts up to 100 provider user IDs.
1486+
Any provider user IDs not found are ignored.
1487+
required: false
14661488
- $ref: '#/components/parameters/LimitParameter'
14671489
- $ref: '#/components/parameters/OffsetParameter'
14681490
- name: order_by
@@ -1860,6 +1882,29 @@ paths:
18601882
example: 1700690400000
18611883
schema:
18621884
type: integer
1885+
- name: provider
1886+
in: query
1887+
schema:
1888+
type: string
1889+
description: |-
1890+
Counts users with external accounts for the specified OAuth provider.
1891+
Must be used in combination with the `provider_user_id` parameter.
1892+
For example, use `provider=oauth_google&provider_user_id=12345` to count users with Google provider user ID 12345.
1893+
Accepts up to 100 providers.
1894+
required: false
1895+
- name: provider_user_id
1896+
in: query
1897+
schema:
1898+
type: array
1899+
items:
1900+
type: string
1901+
description: |-
1902+
Counts users with the specified provider user IDs for a specific provider.
1903+
Must be used in combination with the `provider` parameter.
1904+
For example, use `provider=oauth_google&provider_user_id=12345` to count users with Google provider user ID 12345.
1905+
Accepts up to 100 provider user IDs.
1906+
Any provider user IDs not found are ignored.
1907+
required: false
18631908
responses:
18641909
'200':
18651910
$ref: '#/components/responses/User.Count'
@@ -3218,7 +3263,7 @@ paths:
32183263
nullable: true
32193264
progressive_sign_up:
32203265
type: boolean
3221-
description: Enable the Progressive Sign Up algorithm. Refer to the [docs](https://clerk.com/docs/upgrade-guides/progressive-sign-up) for more info.
3266+
description: Enable the Progressive Sign Up algorithm. This feature is deprecated, please contact support if you need assistance.
32223267
nullable: true
32233268
test_mode:
32243269
type: boolean

‎bapi/2024-10-01.yml‎

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1463,6 +1463,28 @@ paths:
14631463
example: 1700690400000
14641464
schema:
14651465
type: integer
1466+
- name: provider
1467+
in: query
1468+
schema:
1469+
type: string
1470+
description: |-
1471+
Returns users with external accounts for the specified OAuth provider.
1472+
Must be used in combination with the `provider_user_id` parameter.
1473+
For example, use `provider=oauth_google&provider_user_id=12345` to retrieve a user with Google provider user ID 12345.
1474+
required: false
1475+
- name: provider_user_id
1476+
in: query
1477+
schema:
1478+
type: array
1479+
items:
1480+
type: string
1481+
description: |-
1482+
Returns users with the specified provider user IDs for a specific provider.
1483+
Must be used in combination with the `provider` parameter.
1484+
For example, use `provider=oauth_google&provider_user_id=12345` to retrieve a user with Google provider user ID 12345.
1485+
Accepts up to 100 provider user IDs.
1486+
Any provider user IDs not found are ignored.
1487+
required: false
14661488
- $ref: '#/components/parameters/LimitParameter'
14671489
- $ref: '#/components/parameters/OffsetParameter'
14681490
- name: order_by
@@ -1860,6 +1882,29 @@ paths:
18601882
example: 1700690400000
18611883
schema:
18621884
type: integer
1885+
- name: provider
1886+
in: query
1887+
schema:
1888+
type: string
1889+
description: |-
1890+
Counts users with external accounts for the specified OAuth provider.
1891+
Must be used in combination with the `provider_user_id` parameter.
1892+
For example, use `provider=oauth_google&provider_user_id=12345` to count users with Google provider user ID 12345.
1893+
Accepts up to 100 providers.
1894+
required: false
1895+
- name: provider_user_id
1896+
in: query
1897+
schema:
1898+
type: array
1899+
items:
1900+
type: string
1901+
description: |-
1902+
Counts users with the specified provider user IDs for a specific provider.
1903+
Must be used in combination with the `provider` parameter.
1904+
For example, use `provider=oauth_google&provider_user_id=12345` to count users with Google provider user ID 12345.
1905+
Accepts up to 100 provider user IDs.
1906+
Any provider user IDs not found are ignored.
1907+
required: false
18631908
responses:
18641909
'200':
18651910
$ref: '#/components/responses/User.Count'
@@ -3218,7 +3263,7 @@ paths:
32183263
nullable: true
32193264
progressive_sign_up:
32203265
type: boolean
3221-
description: Enable the Progressive Sign Up algorithm. Refer to the [docs](https://clerk.com/docs/upgrade-guides/progressive-sign-up) for more info.
3266+
description: Enable the Progressive Sign Up algorithm. This feature is deprecated, please contact support if you need assistance.
32223267
nullable: true
32233268
test_mode:
32243269
type: boolean

‎bapi/2025-04-10.yml‎

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1419,6 +1419,28 @@ paths:
14191419
example: 1700690400000
14201420
schema:
14211421
type: integer
1422+
- name: provider
1423+
in: query
1424+
schema:
1425+
type: string
1426+
description: |-
1427+
Returns users with external accounts for the specified OAuth provider.
1428+
Must be used in combination with the `provider_user_id` parameter.
1429+
For example, use `provider=oauth_google&provider_user_id=12345` to retrieve a user with Google provider user ID 12345.
1430+
required: false
1431+
- name: provider_user_id
1432+
in: query
1433+
schema:
1434+
type: array
1435+
items:
1436+
type: string
1437+
description: |-
1438+
Returns users with the specified provider user IDs for a specific provider.
1439+
Must be used in combination with the `provider` parameter.
1440+
For example, use `provider=oauth_google&provider_user_id=12345` to retrieve a user with Google provider user ID 12345.
1441+
Accepts up to 100 provider user IDs.
1442+
Any provider user IDs not found are ignored.
1443+
required: false
14221444
- $ref: '#/components/parameters/LimitParameter'
14231445
- $ref: '#/components/parameters/OffsetParameter'
14241446
- name: order_by
@@ -1816,6 +1838,29 @@ paths:
18161838
example: 1700690400000
18171839
schema:
18181840
type: integer
1841+
- name: provider
1842+
in: query
1843+
schema:
1844+
type: string
1845+
description: |-
1846+
Counts users with external accounts for the specified OAuth provider.
1847+
Must be used in combination with the `provider_user_id` parameter.
1848+
For example, use `provider=oauth_google&provider_user_id=12345` to count users with Google provider user ID 12345.
1849+
Accepts up to 100 providers.
1850+
required: false
1851+
- name: provider_user_id
1852+
in: query
1853+
schema:
1854+
type: array
1855+
items:
1856+
type: string
1857+
description: |-
1858+
Counts users with the specified provider user IDs for a specific provider.
1859+
Must be used in combination with the `provider` parameter.
1860+
For example, use `provider=oauth_google&provider_user_id=12345` to count users with Google provider user ID 12345.
1861+
Accepts up to 100 provider user IDs.
1862+
Any provider user IDs not found are ignored.
1863+
required: false
18191864
responses:
18201865
'200':
18211866
$ref: '#/components/responses/User.Count'
@@ -3209,7 +3254,7 @@ paths:
32093254
nullable: true
32103255
progressive_sign_up:
32113256
type: boolean
3212-
description: Enable the Progressive Sign Up algorithm. Refer to the [docs](https://clerk.com/docs/upgrade-guides/progressive-sign-up) for more info.
3257+
description: Enable the Progressive Sign Up algorithm. This feature is deprecated, please contact support if you need assistance.
32133258
nullable: true
32143259
test_mode:
32153260
type: boolean

‎bapi/2025-11-10.yml‎

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1423,6 +1423,28 @@ paths:
14231423
example: 1700690400000
14241424
schema:
14251425
type: integer
1426+
- name: provider
1427+
in: query
1428+
schema:
1429+
type: string
1430+
description: |-
1431+
Returns users with external accounts for the specified OAuth provider.
1432+
Must be used in combination with the `provider_user_id` parameter.
1433+
For example, use `provider=oauth_google&provider_user_id=12345` to retrieve a user with Google provider user ID 12345.
1434+
required: false
1435+
- name: provider_user_id
1436+
in: query
1437+
schema:
1438+
type: array
1439+
items:
1440+
type: string
1441+
description: |-
1442+
Returns users with the specified provider user IDs for a specific provider.
1443+
Must be used in combination with the `provider` parameter.
1444+
For example, use `provider=oauth_google&provider_user_id=12345` to retrieve a user with Google provider user ID 12345.
1445+
Accepts up to 100 provider user IDs.
1446+
Any provider user IDs not found are ignored.
1447+
required: false
14261448
- $ref: '#/components/parameters/LimitParameter'
14271449
- $ref: '#/components/parameters/OffsetParameter'
14281450
- name: order_by
@@ -1820,6 +1842,29 @@ paths:
18201842
example: 1700690400000
18211843
schema:
18221844
type: integer
1845+
- name: provider
1846+
in: query
1847+
schema:
1848+
type: string
1849+
description: |-
1850+
Counts users with external accounts for the specified OAuth provider.
1851+
Must be used in combination with the `provider_user_id` parameter.
1852+
For example, use `provider=oauth_google&provider_user_id=12345` to count users with Google provider user ID 12345.
1853+
Accepts up to 100 providers.
1854+
required: false
1855+
- name: provider_user_id
1856+
in: query
1857+
schema:
1858+
type: array
1859+
items:
1860+
type: string
1861+
description: |-
1862+
Counts users with the specified provider user IDs for a specific provider.
1863+
Must be used in combination with the `provider` parameter.
1864+
For example, use `provider=oauth_google&provider_user_id=12345` to count users with Google provider user ID 12345.
1865+
Accepts up to 100 provider user IDs.
1866+
Any provider user IDs not found are ignored.
1867+
required: false
18231868
responses:
18241869
'200':
18251870
$ref: '#/components/responses/User.Count'
@@ -3281,7 +3326,7 @@ paths:
32813326
nullable: true
32823327
progressive_sign_up:
32833328
type: boolean
3284-
description: Enable the Progressive Sign Up algorithm. Refer to the [docs](https://clerk.com/docs/upgrade-guides/progressive-sign-up) for more info.
3329+
description: Enable the Progressive Sign Up algorithm. This feature is deprecated, please contact support if you need assistance.
32853330
nullable: true
32863331
test_mode:
32873332
type: boolean

‎fapi/2025-11-10.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,8 @@ tags:
103103
description: Used to interact with the waitlist.
104104
- name: API Keys
105105
description: Endpoints for managing API Keys
106+
- name: Enterprise Connections
107+
description: Endpoints for managing enterprise connections.
106108
- name: Plans
107109
description: Used to interact with plans that users and organizations can purchase.
108110
- name: Subscriptions
@@ -914,6 +916,7 @@ paths:
914916
'404':
915917
$ref: '#/components/responses/ClerkErrors'
916918
/v1/enterprise_connections/{enterpriseConnectionID}/init_test_run: {}
919+
/v1/enterprise_connections/{enterpriseConnectionID}/test_runs/{testRunID}: {}
917920
/v1/health:
918921
get:
919922
summary: Get Health
@@ -13567,3 +13570,4 @@ x-tagGroups:
1356713570
- OAuth2 Callbacks
1356813571
- SAML
1356913572
- Waitlist
13573+
- Enterprise Connections

0 commit comments

Comments
 (0)