Skip to content

chore: Update OpenAPI Specs #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thiskevinwang merged 1 commit into from
Jun 16, 2026
Merged

chore: Update OpenAPI Specs #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions bapi/2021-02-05.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6287,7 +6287,7 @@ paths:
nullable: false
enrollment_mode:
type: string
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion` or `manual_invitation`
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`
nullable: false
verified:
type: boolean
Expand Down Expand Up @@ -6328,7 +6328,9 @@ paths:
- in: query
required: false
name: enrollment_mode
description: Filter domains by their enrollment mode
description: |-
Filter domains by their enrollment mode. Accepts `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`.
Prefix a value with `-` to exclude it instead (e.g. `-enterprise_sso`). Include and exclude filters can be combined and compose as AND.
schema:
type: string
- $ref: '#/components/parameters/LimitParameter'
Expand Down Expand Up @@ -6371,7 +6373,7 @@ paths:
properties:
enrollment_mode:
type: string
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion` or `manual_invitation`
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`
nullable: true
verified:
type: boolean
Expand All @@ -6382,6 +6384,8 @@ paths:
$ref: '#/components/responses/OrganizationDomain'
'400':
$ref: '#/components/responses/ClerkErrors'
'403':
$ref: '#/components/responses/ClerkErrors'
'404':
$ref: '#/components/responses/ResourceNotFound'
'422':
Expand Down Expand Up @@ -6414,6 +6418,8 @@ paths:
$ref: '#/components/responses/ClerkErrors'
'401':
$ref: '#/components/responses/AuthenticationInvalid'
'403':
$ref: '#/components/responses/ClerkErrors'
'404':
$ref: '#/components/responses/ResourceNotFound'
/organizations/{organization_id}/domains/{domain_id}/verify_ownership:
Expand Down Expand Up @@ -6488,7 +6494,9 @@ paths:
- 'false'
- in: query
name: enrollment_mode
description: Filter by enrollment mode
description: |-
Filter by enrollment mode. Prefix a value with `-` to exclude it instead
(e.g. `-enterprise_sso`). Include and exclude filters can be combined and compose as AND.
required: false
style: form
explode: false
Expand All @@ -6500,6 +6508,11 @@ paths:
- manual_invitation
- automatic_invitation
- automatic_suggestion
- enterprise_sso
- '-manual_invitation'
- '-automatic_invitation'
- '-automatic_suggestion'
- '-enterprise_sso'
- in: query
name: query
description: |
Expand Down Expand Up @@ -11946,6 +11959,7 @@ components:
type: string
meta:
type: object
additionalProperties: true
required:
- message
- long_message
Expand All @@ -11959,6 +11973,7 @@ components:
$ref: '#/components/schemas/ClerkError'
meta:
type: object
additionalProperties: true
clerk_trace_id:
type: string
required:
Expand Down Expand Up @@ -15183,6 +15198,7 @@ components:
- manual_invitation
- automatic_invitation
- automatic_suggestion
- enterprise_sso
affiliation_email_address:
type: string
nullable: true
Expand Down
24 changes: 20 additions & 4 deletions bapi/2024-10-01.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6560,7 +6560,7 @@ paths:
nullable: false
enrollment_mode:
type: string
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion` or `manual_invitation`
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`
nullable: false
verified:
type: boolean
Expand Down Expand Up @@ -6601,7 +6601,9 @@ paths:
- in: query
required: false
name: enrollment_mode
description: Filter domains by their enrollment mode
description: |-
Filter domains by their enrollment mode. Accepts `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`.
Prefix a value with `-` to exclude it instead (e.g. `-enterprise_sso`). Include and exclude filters can be combined and compose as AND.
schema:
type: string
- $ref: '#/components/parameters/LimitParameter'
Expand Down Expand Up @@ -6644,7 +6646,7 @@ paths:
properties:
enrollment_mode:
type: string
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion` or `manual_invitation`
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`
nullable: true
verified:
type: boolean
Expand All @@ -6655,6 +6657,8 @@ paths:
$ref: '#/components/responses/OrganizationDomain'
'400':
$ref: '#/components/responses/ClerkErrors'
'403':
$ref: '#/components/responses/ClerkErrors'
'404':
$ref: '#/components/responses/ResourceNotFound'
'422':
Expand Down Expand Up @@ -6687,6 +6691,8 @@ paths:
$ref: '#/components/responses/ClerkErrors'
'401':
$ref: '#/components/responses/AuthenticationInvalid'
'403':
$ref: '#/components/responses/ClerkErrors'
'404':
$ref: '#/components/responses/ResourceNotFound'
/organizations/{organization_id}/domains/{domain_id}/verify_ownership:
Expand Down Expand Up @@ -6761,7 +6767,9 @@ paths:
- 'false'
- in: query
name: enrollment_mode
description: Filter by enrollment mode
description: |-
Filter by enrollment mode. Prefix a value with `-` to exclude it instead
(e.g. `-enterprise_sso`). Include and exclude filters can be combined and compose as AND.
required: false
style: form
explode: false
Expand All @@ -6773,6 +6781,11 @@ paths:
- manual_invitation
- automatic_invitation
- automatic_suggestion
- enterprise_sso
- '-manual_invitation'
- '-automatic_invitation'
- '-automatic_suggestion'
- '-enterprise_sso'
- in: query
name: query
description: |
Expand Down Expand Up @@ -12219,6 +12232,7 @@ components:
type: string
meta:
type: object
additionalProperties: true
required:
- message
- long_message
Expand All @@ -12232,6 +12246,7 @@ components:
$ref: '#/components/schemas/ClerkError'
meta:
type: object
additionalProperties: true
clerk_trace_id:
type: string
required:
Expand Down Expand Up @@ -15552,6 +15567,7 @@ components:
- manual_invitation
- automatic_invitation
- automatic_suggestion
- enterprise_sso
affiliation_email_address:
type: string
nullable: true
Expand Down
24 changes: 20 additions & 4 deletions bapi/2025-04-10.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6553,7 +6553,7 @@ paths:
nullable: false
enrollment_mode:
type: string
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion` or `manual_invitation`
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`
nullable: false
verified:
type: boolean
Expand Down Expand Up @@ -6594,7 +6594,9 @@ paths:
- in: query
required: false
name: enrollment_mode
description: Filter domains by their enrollment mode
description: |-
Filter domains by their enrollment mode. Accepts `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`.
Prefix a value with `-` to exclude it instead (e.g. `-enterprise_sso`). Include and exclude filters can be combined and compose as AND.
schema:
type: string
- $ref: '#/components/parameters/LimitParameter'
Expand Down Expand Up @@ -6637,7 +6639,7 @@ paths:
properties:
enrollment_mode:
type: string
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion` or `manual_invitation`
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`
nullable: true
verified:
type: boolean
Expand All @@ -6648,6 +6650,8 @@ paths:
$ref: '#/components/responses/OrganizationDomain'
'400':
$ref: '#/components/responses/ClerkErrors'
'403':
$ref: '#/components/responses/ClerkErrors'
'404':
$ref: '#/components/responses/ResourceNotFound'
'422':
Expand Down Expand Up @@ -6680,6 +6684,8 @@ paths:
$ref: '#/components/responses/ClerkErrors'
'401':
$ref: '#/components/responses/AuthenticationInvalid'
'403':
$ref: '#/components/responses/ClerkErrors'
'404':
$ref: '#/components/responses/ResourceNotFound'
/organizations/{organization_id}/domains/{domain_id}/verify_ownership:
Expand Down Expand Up @@ -6754,7 +6760,9 @@ paths:
- 'false'
- in: query
name: enrollment_mode
description: Filter by enrollment mode
description: |-
Filter by enrollment mode. Prefix a value with `-` to exclude it instead
(e.g. `-enterprise_sso`). Include and exclude filters can be combined and compose as AND.
required: false
style: form
explode: false
Expand All @@ -6766,6 +6774,11 @@ paths:
- manual_invitation
- automatic_invitation
- automatic_suggestion
- enterprise_sso
- '-manual_invitation'
- '-automatic_invitation'
- '-automatic_suggestion'
- '-enterprise_sso'
- in: query
name: query
description: |
Expand Down Expand Up @@ -12225,6 +12238,7 @@ components:
type: string
meta:
type: object
additionalProperties: true
required:
- message
- long_message
Expand All @@ -12238,6 +12252,7 @@ components:
$ref: '#/components/schemas/ClerkError'
meta:
type: object
additionalProperties: true
clerk_trace_id:
type: string
required:
Expand Down Expand Up @@ -15558,6 +15573,7 @@ components:
- manual_invitation
- automatic_invitation
- automatic_suggestion
- enterprise_sso
affiliation_email_address:
type: string
nullable: true
Expand Down
29 changes: 24 additions & 5 deletions bapi/2025-11-10.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3356,7 +3356,10 @@ paths:
x-speakeasy-group: users
x-speakeasy-name-override: unsetPasswordCompromised
summary: Unset a user's password as compromised
description: Sets the given user's password as no longer compromised. The user will no longer be prompted to reset their password on their next sign-in.
description: |-
Sets the given user's password as no longer compromised. The user will no longer be prompted to reset their password on their next sign-in.

If the user is in reserved-email password quarantine, the quarantine is preserved and the returned user will still have `requires_password_reset` set to `true`. Reserved-email password quarantine can only be cleared by completing a password reset or changing/removing the password.
tags:
- Users
parameters:
Expand Down Expand Up @@ -6627,7 +6630,7 @@ paths:
nullable: false
enrollment_mode:
type: string
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion` or `manual_invitation`
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`
nullable: false
verified:
type: boolean
Expand Down Expand Up @@ -6668,7 +6671,9 @@ paths:
- in: query
required: false
name: enrollment_mode
description: Filter domains by their enrollment mode
description: |-
Filter domains by their enrollment mode. Accepts `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`.
Prefix a value with `-` to exclude it instead (e.g. `-enterprise_sso`). Include and exclude filters can be combined and compose as AND.
schema:
type: string
- $ref: '#/components/parameters/LimitParameter'
Expand Down Expand Up @@ -6711,7 +6716,7 @@ paths:
properties:
enrollment_mode:
type: string
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion` or `manual_invitation`
description: The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`
nullable: true
verified:
type: boolean
Expand All @@ -6722,6 +6727,8 @@ paths:
$ref: '#/components/responses/OrganizationDomain'
'400':
$ref: '#/components/responses/ClerkErrors'
'403':
$ref: '#/components/responses/ClerkErrors'
'404':
$ref: '#/components/responses/ResourceNotFound'
'422':
Expand Down Expand Up @@ -6754,6 +6761,8 @@ paths:
$ref: '#/components/responses/ClerkErrors'
'401':
$ref: '#/components/responses/AuthenticationInvalid'
'403':
$ref: '#/components/responses/ClerkErrors'
'404':
$ref: '#/components/responses/ResourceNotFound'
/organizations/{organization_id}/domains/{domain_id}/verify_ownership:
Expand Down Expand Up @@ -6828,7 +6837,9 @@ paths:
- 'false'
- in: query
name: enrollment_mode
description: Filter by enrollment mode
description: |-
Filter by enrollment mode. Prefix a value with `-` to exclude it instead
(e.g. `-enterprise_sso`). Include and exclude filters can be combined and compose as AND.
required: false
style: form
explode: false
Expand All @@ -6840,6 +6851,11 @@ paths:
- manual_invitation
- automatic_invitation
- automatic_suggestion
- enterprise_sso
- '-manual_invitation'
- '-automatic_invitation'
- '-automatic_suggestion'
- '-enterprise_sso'
- in: query
name: query
description: |
Expand Down Expand Up @@ -12587,6 +12603,7 @@ components:
type: string
meta:
type: object
additionalProperties: true
required:
- message
- long_message
Expand All @@ -12600,6 +12617,7 @@ components:
$ref: '#/components/schemas/ClerkError'
meta:
type: object
additionalProperties: true
clerk_trace_id:
type: string
required:
Expand Down Expand Up @@ -16039,6 +16057,7 @@ components:
- manual_invitation
- automatic_invitation
- automatic_suggestion
- enterprise_sso
affiliation_email_address:
type: string
nullable: true
Expand Down
Loading
Loading