You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .speakeasy/out.openapi.yaml
+69-52Lines changed: 69 additions & 52 deletions
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ info:
18
18
Each version is identified by its release date, e.g. `2025-04-10`. For more information, please see [Clerk API Versions](https://clerk.com/docs/versioning/available-versions).
19
19
20
20
Please see https://clerk.com/docs for more information.
21
-
version: '2025-11-10'
21
+
version: '2026-05-12'
22
22
termsOfService: https://clerk.com/terms
23
23
license:
24
24
name: MIT
@@ -2266,12 +2266,9 @@ paths:
2266
2266
Both IDs should correspond to verified identifications that belong to the user.
2267
2267
2268
2268
You can remove a user's username by setting the username attribute to null or the blank string "".
2269
-
This is a destructive action; the identification will be deleted forever.
2270
-
Usernames can be removed only if they are optional in your instance settings and there's at least one other identifier which can be used for authentication.
2271
2269
2272
-
This endpoint allows changing a user's password. When passing the `password` parameter directly you have two further options.
2273
-
You can ignore the password policy checks for your instance by setting the `skip_password_checks` parameter to `true`.
2274
-
You can also choose to sign the user out of all their active sessions on any device once the password is updated. Just set `sign_out_of_other_sessions` to `true`.
2270
+
As of API version 2026-05-12, this endpoint no longer accepts `public_metadata`, `private_metadata`, or `unsafe_metadata`.
2271
+
Use `PATCH /v1/users/{user_id}/metadata` to merge updates into existing metadata, or `PUT /v1/users/{user_id}/metadata` to replace a metadata field entirely.
2275
2272
tags:
2276
2273
- Users
2277
2274
parameters:
@@ -2366,37 +2363,13 @@ paths:
2366
2363
nullable: true
2367
2364
totp_secret:
2368
2365
type: string
2369
-
description: |-
2370
-
In case TOTP is configured on the instance, you can provide the secret to enable it on the specific user without the need to reset it.
2371
-
Please note that currently the supported options are:
2372
-
* Period: 30 seconds
2373
-
* Code length: 6 digits
2374
-
* Algorithm: SHA1
2366
+
description: In case TOTP is configured on the instance, you can provide the secret to enable it on the specific user without the need to reset it.
2375
2367
nullable: true
2376
2368
backup_codes:
2377
2369
type: array
2378
2370
items:
2379
2371
type: string
2380
-
description: |-
2381
-
If Backup Codes are configured on the instance, you can provide them to enable it on the specific user without the need to reset them.
2382
-
You must provide the backup codes in plain format or the corresponding bcrypt digest.
2383
-
public_metadata:
2384
-
type: object
2385
-
description: Metadata saved on the user, that is visible to both your Frontend and Backend APIs
2386
-
additionalProperties: true
2387
-
nullable: true
2388
-
private_metadata:
2389
-
type: object
2390
-
description: Metadata saved on the user, that is only visible to your Backend API
2391
-
additionalProperties: true
2392
-
nullable: true
2393
-
unsafe_metadata:
2394
-
type: object
2395
-
description: |-
2396
-
Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
2397
-
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe.
2398
-
additionalProperties: true
2399
-
nullable: true
2372
+
description: If Backup Codes are configured on the instance, you can provide them to enable it on the specific user without the need to reset them.
2400
2373
delete_self_enabled:
2401
2374
type: boolean
2402
2375
description: If true, the user can delete themselves with the Frontend API.
@@ -2407,21 +2380,19 @@ paths:
2407
2380
nullable: true
2408
2381
legal_accepted_at:
2409
2382
type: string
2410
-
description: A custom timestamp denoting _when_ the user accepted legal requirements, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`).
2383
+
description: A custom timestamp denoting _when_ the user accepted legal requirements, specified in RFC3339 format.
2411
2384
nullable: true
2412
2385
skip_legal_checks:
2413
2386
type: boolean
2414
-
description: |-
2415
-
When set to `true` all legal checks are skipped.
2416
-
It is not recommended to skip legal checks unless you are migrating a user to Clerk.
2387
+
description: When set to `true` all legal checks are skipped.
2417
2388
nullable: true
2418
2389
create_organizations_limit:
2419
2390
type: integer
2420
2391
description: The maximum number of organizations the user can create. 0 means unlimited.
2421
2392
nullable: true
2422
2393
created_at:
2423
2394
type: string
2424
-
description: A custom date/time denoting _when_ the user signed up to the application, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`).
2395
+
description: A custom date/time denoting _when_ the user signed up to the application.
2425
2396
nullable: true
2426
2397
bypass_client_trust:
2427
2398
type: boolean
@@ -2740,12 +2711,12 @@ paths:
2740
2711
Replace a user's metadata attributes with the provided values.
2741
2712
2742
2713
Unlike `PATCH /v1/users/{user_id}/metadata` (merge semantics), this endpoint
2743
-
replaces the supplied metadata columns entirely — the prior contents of each
2744
-
supplied column are discarded. Columns omitted from the request body are
2714
+
replaces the supplied metadata fields entirely — the prior contents of each
2715
+
supplied field are discarded. Fields omitted from the request body are
2745
2716
left unchanged.
2746
2717
2747
2718
Prefer the `PATCH` endpoint for partial updates. Use `PUT` only when you
2748
-
explicitly intend to overwrite a metadata column wholesale.
2719
+
explicitly intend to overwrite a metadata field wholesale.
2749
2720
tags:
2750
2721
- Users
2751
2722
parameters:
@@ -5213,7 +5184,11 @@ paths:
5213
5184
x-speakeasy-group: organizations
5214
5185
x-speakeasy-name-override: update
5215
5186
summary: Update an organization
5216
-
description: Updates an existing organization
5187
+
description: |-
5188
+
Updates an existing organization.
5189
+
5190
+
As of API version 2026-05-12, this endpoint no longer accepts `public_metadata` or `private_metadata`.
5191
+
Use `PATCH /v1/organizations/{organization_id}/metadata` to merge updates into existing metadata, or `PUT /v1/organizations/{organization_id}/metadata` to replace a metadata field entirely.
5217
5192
tags:
5218
5193
- Organizations
5219
5194
parameters:
@@ -5231,16 +5206,6 @@ paths:
5231
5206
type: object
5232
5207
additionalProperties: false
5233
5208
properties:
5234
-
public_metadata:
5235
-
type: object
5236
-
description: Metadata saved on the organization, that is visible to both your frontend and backend.
5237
-
additionalProperties: true
5238
-
nullable: true
5239
-
private_metadata:
5240
-
type: object
5241
-
description: Metadata saved on the organization that is only visible to your backend.
|`public_metadata`| Crystalline::Hash[Symbol, *::Object*]|:heavy_minus_sign:| Metadata saved on the organization, that is visible to both your frontend and backend.<br/>The existing value will be replaced entirely with the new object. |
9
+
|`private_metadata`| Crystalline::Hash[Symbol, *::Object*]|:heavy_minus_sign:| Metadata saved on the organization that is only visible to your backend.<br/>The existing value will be replaced entirely with the new object. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments