From 3bb25429bed370ba389e947485a5d97e7a3f867e Mon Sep 17 00:00:00 2001 From: Clerk Bot Date: Wed, 2 Apr 2025 12:11:36 +0000 Subject: [PATCH] chore: Update OpenAPI Specs --- bapi/2021-02-05.yml | 156 ++++++++++++++++------- bapi/2024-10-01.yml | 156 ++++++++++++++++------- bapi/2025-03-12.yml | 169 ++++++++++++++++++------- fapi/2025-03-12.yml | 293 +++++++++++++++++++++++++++++++++----------- 4 files changed, 573 insertions(+), 201 deletions(-) diff --git a/bapi/2021-02-05.yml b/bapi/2021-02-05.yml index 28ce847..d55687e 100644 --- a/bapi/2021-02-05.yml +++ b/bapi/2021-02-05.yml @@ -131,6 +131,8 @@ tags: description: Check if a user is using a proxy. - name: Organization Domains description: Manage organization domains. + - name: Accountless Applications + description: Create and complete accountless applications. Note that this is an experimental feature and subject to change or be removed without notice. externalDocs: url: https://clerk.com/docs paths: @@ -2244,50 +2246,7 @@ paths: - $ref: '#/components/parameters/OffsetParameter' responses: '200': - description: The OAuth access token of the user, if any. - content: - application/json: - schema: - type: array - items: - type: object - additionalProperties: false - properties: - object: - type: string - external_account_id: - description: External account ID - type: string - provider_user_id: - description: The unique ID of the user in the external provider's system - type: string - token: - type: string - description: The access token - provider: - type: string - description: The ID of the provider - public_metadata: - type: object - additionalProperties: true - label: - type: string - nullable: true - scopes: - type: array - items: - type: string - description: |- - The list of scopes that the token is valid for. - Only present for OAuth 2.0 tokens. - token_secret: - type: string - description: The token secret. Only present for OAuth 1.0 tokens. - expires_at: - type: integer - format: int64 - nullable: true - description: Unix timestamp of the access token expiration. + $ref: '#/components/responses/OAuthAccessToken' '400': $ref: '#/components/responses/ClerkErrors' '404': @@ -5887,6 +5846,34 @@ paths: $ref: '#/components/responses/ClerkErrors' '422': $ref: '#/components/responses/UnprocessableEntity' + /accountless_applications: + post: + operationId: CreateAccountlessApplication + x-speakeasy-group: experimentalAccountlessApplications + x-speakeasy-name-override: create + summary: Create an accountless application [EXPERIMENTAL] + description: Creates a new accountless application. [EXPERIMENTAL] + tags: + - Accountless Applications + responses: + '200': + $ref: '#/components/responses/AccountlessApplication' + '500': + $ref: '#/components/responses/ClerkErrors' + /accountless_applications/complete: + post: + operationId: CompleteAccountlessApplication + x-speakeasy-group: experimentalAccountlessApplications + x-speakeasy-name-override: complete + summary: Complete an accountless application [EXPERIMENTAL] + description: Completes an accountless application. [EXPERIMENTAL] + tags: + - Accountless Applications + responses: + '200': + $ref: '#/components/responses/AccountlessApplication' + '500': + $ref: '#/components/responses/ClerkErrors' components: securitySchemes: bearerAuth: @@ -7308,6 +7295,56 @@ components: required: - object - total_count + OAuthAccessToken: + type: array + items: + type: object + additionalProperties: false + properties: + object: + type: string + enum: + - oauth_access_token + external_account_id: + type: string + description: External account ID + provider_user_id: + type: string + description: The unique ID of the user in the external provider's system + token: + type: string + description: The access token + expires_at: + type: integer + format: int64 + nullable: true + description: Unix timestamp of the access token expiration. + provider: + type: string + description: The ID of the provider + public_metadata: + type: object + additionalProperties: true + label: + type: string + nullable: true + scopes: + type: array + items: + type: string + description: The list of scopes that the token is valid for. Only present for OAuth 2.0 tokens. + token_secret: + type: string + description: The token secret. Only present for OAuth 1.0 tokens. + required: + - object + - external_account_id + - provider_user_id + - token + - expires_at + - provider + - public_metadata + - label Organization: type: object properties: @@ -8685,6 +8722,25 @@ components: - status - created_at - updated_at + AccountlessApplication: + type: object + additionalProperties: false + properties: + object: + type: string + enum: + - accountless_application + publishable_key: + type: string + secret_key: + type: string + claim_url: + type: string + api_keys_url: + type: string + required: + - object + - publishable_key responses: WellKnown.JWKS: description: Get the JSON Web Key Set @@ -8820,6 +8876,12 @@ components: application/json: schema: $ref: '#/components/schemas/TotalCount' + OAuthAccessToken: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/OAuthAccessToken' OrganizationMemberships: description: A list of organization memberships content: @@ -9108,6 +9170,12 @@ components: application/json: schema: $ref: '#/components/schemas/WaitlistEntry' + AccountlessApplication: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountlessApplication' parameters: Paginated: name: paginated diff --git a/bapi/2024-10-01.yml b/bapi/2024-10-01.yml index 2d84475..c95d4cc 100644 --- a/bapi/2024-10-01.yml +++ b/bapi/2024-10-01.yml @@ -131,6 +131,8 @@ tags: description: Check if a user is using a proxy. - name: Organization Domains description: Manage organization domains. + - name: Accountless Applications + description: Create and complete accountless applications. Note that this is an experimental feature and subject to change or be removed without notice. externalDocs: url: https://clerk.com/docs paths: @@ -2244,50 +2246,7 @@ paths: - $ref: '#/components/parameters/OffsetParameter' responses: '200': - description: The OAuth access token of the user, if any. - content: - application/json: - schema: - type: array - items: - type: object - additionalProperties: false - properties: - object: - type: string - external_account_id: - description: External account ID - type: string - provider_user_id: - description: The unique ID of the user in the external provider's system - type: string - token: - type: string - description: The access token - provider: - type: string - description: The ID of the provider - public_metadata: - type: object - additionalProperties: true - label: - type: string - nullable: true - scopes: - type: array - items: - type: string - description: |- - The list of scopes that the token is valid for. - Only present for OAuth 2.0 tokens. - token_secret: - type: string - description: The token secret. Only present for OAuth 1.0 tokens. - expires_at: - type: integer - format: int64 - nullable: true - description: Unix timestamp of the access token expiration. + $ref: '#/components/responses/OAuthAccessToken' '400': $ref: '#/components/responses/ClerkErrors' '404': @@ -5883,6 +5842,34 @@ paths: $ref: '#/components/responses/ClerkErrors' '422': $ref: '#/components/responses/UnprocessableEntity' + /accountless_applications: + post: + operationId: CreateAccountlessApplication + x-speakeasy-group: experimentalAccountlessApplications + x-speakeasy-name-override: create + summary: Create an accountless application [EXPERIMENTAL] + description: Creates a new accountless application. [EXPERIMENTAL] + tags: + - Accountless Applications + responses: + '200': + $ref: '#/components/responses/AccountlessApplication' + '500': + $ref: '#/components/responses/ClerkErrors' + /accountless_applications/complete: + post: + operationId: CompleteAccountlessApplication + x-speakeasy-group: experimentalAccountlessApplications + x-speakeasy-name-override: complete + summary: Complete an accountless application [EXPERIMENTAL] + description: Completes an accountless application. [EXPERIMENTAL] + tags: + - Accountless Applications + responses: + '200': + $ref: '#/components/responses/AccountlessApplication' + '500': + $ref: '#/components/responses/ClerkErrors' components: securitySchemes: bearerAuth: @@ -7304,6 +7291,56 @@ components: required: - object - total_count + OAuthAccessToken: + type: array + items: + type: object + additionalProperties: false + properties: + object: + type: string + enum: + - oauth_access_token + external_account_id: + type: string + description: External account ID + provider_user_id: + type: string + description: The unique ID of the user in the external provider's system + token: + type: string + description: The access token + expires_at: + type: integer + format: int64 + nullable: true + description: Unix timestamp of the access token expiration. + provider: + type: string + description: The ID of the provider + public_metadata: + type: object + additionalProperties: true + label: + type: string + nullable: true + scopes: + type: array + items: + type: string + description: The list of scopes that the token is valid for. Only present for OAuth 2.0 tokens. + token_secret: + type: string + description: The token secret. Only present for OAuth 1.0 tokens. + required: + - object + - external_account_id + - provider_user_id + - token + - expires_at + - provider + - public_metadata + - label Organization: type: object properties: @@ -8681,6 +8718,25 @@ components: - status - created_at - updated_at + AccountlessApplication: + type: object + additionalProperties: false + properties: + object: + type: string + enum: + - accountless_application + publishable_key: + type: string + secret_key: + type: string + claim_url: + type: string + api_keys_url: + type: string + required: + - object + - publishable_key responses: WellKnown.JWKS: description: Get the JSON Web Key Set @@ -8816,6 +8872,12 @@ components: application/json: schema: $ref: '#/components/schemas/TotalCount' + OAuthAccessToken: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/OAuthAccessToken' OrganizationMemberships: description: A list of organization memberships content: @@ -9104,6 +9166,12 @@ components: application/json: schema: $ref: '#/components/schemas/WaitlistEntry' + AccountlessApplication: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountlessApplication' parameters: Paginated: name: paginated diff --git a/bapi/2025-03-12.yml b/bapi/2025-03-12.yml index d511225..8feddf1 100644 --- a/bapi/2025-03-12.yml +++ b/bapi/2025-03-12.yml @@ -131,6 +131,8 @@ tags: description: Check if a user is using a proxy. - name: Organization Domains description: Manage organization domains. + - name: Accountless Applications + description: Create and complete accountless applications. Note that this is an experimental feature and subject to change or be removed without notice. externalDocs: url: https://clerk.com/docs paths: @@ -2244,50 +2246,7 @@ paths: - $ref: '#/components/parameters/OffsetParameter' responses: '200': - description: The OAuth access token of the user, if any. - content: - application/json: - schema: - type: array - items: - type: object - additionalProperties: false - properties: - object: - type: string - external_account_id: - description: External account ID - type: string - provider_user_id: - description: The unique ID of the user in the external provider's system - type: string - token: - type: string - description: The access token - provider: - type: string - description: The ID of the provider - public_metadata: - type: object - additionalProperties: true - label: - type: string - nullable: true - scopes: - type: array - items: - type: string - description: |- - The list of scopes that the token is valid for. - Only present for OAuth 2.0 tokens. - token_secret: - type: string - description: The token secret. Only present for OAuth 1.0 tokens. - expires_at: - type: integer - format: int64 - nullable: true - description: Unix timestamp of the access token expiration. + $ref: '#/components/responses/OAuthAccessToken' '400': $ref: '#/components/responses/ClerkErrors' '404': @@ -5883,6 +5842,34 @@ paths: $ref: '#/components/responses/ClerkErrors' '422': $ref: '#/components/responses/UnprocessableEntity' + /accountless_applications: + post: + operationId: CreateAccountlessApplication + x-speakeasy-group: experimentalAccountlessApplications + x-speakeasy-name-override: create + summary: Create an accountless application [EXPERIMENTAL] + description: Creates a new accountless application. [EXPERIMENTAL] + tags: + - Accountless Applications + responses: + '200': + $ref: '#/components/responses/AccountlessApplication' + '500': + $ref: '#/components/responses/ClerkErrors' + /accountless_applications/complete: + post: + operationId: CompleteAccountlessApplication + x-speakeasy-group: experimentalAccountlessApplications + x-speakeasy-name-override: complete + summary: Complete an accountless application [EXPERIMENTAL] + description: Completes an accountless application. [EXPERIMENTAL] + tags: + - Accountless Applications + responses: + '200': + $ref: '#/components/responses/AccountlessApplication' + '500': + $ref: '#/components/responses/ClerkErrors' components: securitySchemes: bearerAuth: @@ -6199,6 +6186,13 @@ components: - id - object - is_mobile + SessionTask: + type: object + properties: + key: + type: string + required: + - key Session: type: object additionalProperties: false @@ -6228,6 +6222,7 @@ components: - removed - abandoned - replaced + - pending last_active_organization_id: type: string nullable: true @@ -6255,6 +6250,11 @@ components: format: int64 description: | Unix timestamp of creation. + tasks: + type: array + nullable: true + items: + $ref: '#/components/schemas/SessionTask' required: - object - id @@ -7304,6 +7304,56 @@ components: required: - object - total_count + OAuthAccessToken: + type: array + items: + type: object + additionalProperties: false + properties: + object: + type: string + enum: + - oauth_access_token + external_account_id: + type: string + description: External account ID + provider_user_id: + type: string + description: The unique ID of the user in the external provider's system + token: + type: string + description: The access token + expires_at: + type: integer + format: int64 + nullable: true + description: Unix timestamp of the access token expiration. + provider: + type: string + description: The ID of the provider + public_metadata: + type: object + additionalProperties: true + label: + type: string + nullable: true + scopes: + type: array + items: + type: string + description: The list of scopes that the token is valid for. Only present for OAuth 2.0 tokens. + token_secret: + type: string + description: The token secret. Only present for OAuth 1.0 tokens. + required: + - object + - external_account_id + - provider_user_id + - token + - expires_at + - provider + - public_metadata + - label Organization: type: object properties: @@ -8681,6 +8731,25 @@ components: - status - created_at - updated_at + AccountlessApplication: + type: object + additionalProperties: false + properties: + object: + type: string + enum: + - accountless_application + publishable_key: + type: string + secret_key: + type: string + claim_url: + type: string + api_keys_url: + type: string + required: + - object + - publishable_key responses: WellKnown.JWKS: description: Get the JSON Web Key Set @@ -8816,6 +8885,12 @@ components: application/json: schema: $ref: '#/components/schemas/TotalCount' + OAuthAccessToken: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/OAuthAccessToken' OrganizationMemberships: description: A list of organization memberships content: @@ -9104,6 +9179,12 @@ components: application/json: schema: $ref: '#/components/schemas/WaitlistEntry' + AccountlessApplication: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountlessApplication' parameters: Paginated: name: paginated diff --git a/fapi/2025-03-12.yml b/fapi/2025-03-12.yml index a6c82eb..7c643e0 100644 --- a/fapi/2025-03-12.yml +++ b/fapi/2025-03-12.yml @@ -712,7 +712,7 @@ paths: - password responses: '200': - $ref: '#/components/responses/Client.SignIn' + $ref: '#/components/responses/responses-Client.SignIn' '400': $ref: '#/components/responses/ClerkErrors' '422': @@ -3103,12 +3103,6 @@ paths: tags: - User operationId: getUser - parameters: - - in: query - name: _clerk_session_id - description: The session_id associated with the requesting user. - schema: - type: string responses: '200': $ref: '#/components/responses/Client.ClientWrappedUser' @@ -3124,27 +3118,19 @@ paths: tags: - User operationId: patchUser - parameters: - - in: query - name: _clerk_session_id - schema: - type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: - first_name: - nullable: true - type: string - last_name: + username: nullable: true type: string - username: + first_name: nullable: true type: string - password: + last_name: nullable: true type: string primary_email_address_id: @@ -3156,22 +3142,10 @@ paths: primary_web3_wallet_id: nullable: true type: string - public_metadata: - nullable: true - type: string - description: A stringified JSON containing the public metadata of the current user. - private_metadata: - nullable: true - type: string - description: A stringified JSON containing the private metadata of the current user. unsafe_metadata: nullable: true type: string - description: A stringified JSON containing the unsafe metadata of the current user. - profile_image_id: - nullable: true - type: string - description: The profile image ID of the current user. + description: A stringified JSON containing the unsafe medata of the current user. responses: '200': $ref: '#/components/responses/Client.ClientWrappedUser' @@ -3191,11 +3165,6 @@ paths: tags: - User operationId: deleteUser - parameters: - - in: query - name: _clerk_session_id - schema: - type: string responses: '200': $ref: '#/components/responses/Client.ClientWrappedDeletedObject' @@ -3242,15 +3211,9 @@ paths: post: summary: Update Profile Image description: Update the current user's profile image. - operationId: updateProfileImage tags: - User - parameters: - - in: query - name: _clerk_session_id - description: The session_id associated with the requesting user. - schema: - type: string + operationId: updateProfileImage requestBody: required: true content: @@ -3279,12 +3242,6 @@ paths: operationId: deleteProfileImage tags: - User - parameters: - - in: query - name: _clerk_session_id - description: The session_id associated with the requesting user. - schema: - type: string responses: '200': $ref: '#/components/responses/Client.ClientWrappedDeletedObject' @@ -3299,12 +3256,6 @@ paths: operationId: changePassword tags: - User - parameters: - - in: query - name: _clerk_session_id - description: The session_id associated with the requesting user. - schema: - type: string requestBody: content: application/x-www-form-urlencoded: @@ -3320,11 +3271,9 @@ paths: sign_out_of_other_sessions: type: boolean nullable: true - required: - - new_password responses: '200': - $ref: '#/components/responses/Client.ClientWrappedUser' + $ref: '#/components/responses/responses-Client.ClientWrappedUser' '400': $ref: '#/components/responses/ClerkErrors' '403': @@ -3338,12 +3287,6 @@ paths: operationId: removePassword tags: - User - parameters: - - in: query - name: _clerk_session_id - description: The session_id associated with the requesting user. - schema: - type: string requestBody: required: true content: @@ -3354,11 +3297,9 @@ paths: properties: current_password: type: string - required: - - current_password responses: '200': - $ref: '#/components/responses/Client.ClientWrappedUser' + $ref: '#/components/responses/responses-Client.ClientWrappedUser' '400': $ref: '#/components/responses/ClerkErrors' '422': @@ -3649,7 +3590,7 @@ paths: format: base64 responses: '200': - $ref: '#/components/responses/Client.ClientWrappedOrganization' + $ref: '#/components/responses/responses-Client.ClientWrappedOrganization' '400': $ref: '#/components/responses/ClerkErrors' '401': @@ -6030,6 +5971,13 @@ components: required: - object - jwt + Client.SessionTask: + type: object + properties: + key: + type: string + required: + - key Client.SessionBase: type: object properties: @@ -6050,6 +5998,7 @@ components: - expired - removed - abandoned + - pending expire_at: type: integer format: int64 @@ -6068,6 +6017,11 @@ components: type: object nullable: true additionalProperties: true + tasks: + type: array + nullable: true + items: + $ref: '#/components/schemas/Client.SessionTask' required: - id - object @@ -7665,6 +7619,155 @@ components: required: - response - client + schemas-Client.SessionBase: + type: object + properties: + id: + type: string + object: + type: string + description: | + String representing the object's type. Objects of the same type share the same value. + enum: + - session + status: + type: string + enum: + - active + - revoked + - ended + - expired + - removed + - abandoned + expire_at: + type: integer + format: int64 + abandon_at: + type: integer + format: int64 + last_active_at: + type: integer + format: int64 + last_active_token: + type: object + nullable: true + allOf: + - $ref: '#/components/schemas/Token' + actor: + type: object + nullable: true + additionalProperties: true + required: + - id + - object + - status + - expire_at + - abandon_at + - last_active_at + schemas-Client.Session: + allOf: + - $ref: '#/components/schemas/schemas-Client.SessionBase' + - type: object + properties: + last_active_organization_id: + type: string + nullable: true + user: + $ref: '#/components/schemas/Client.User' + public_user_data: + type: object + nullable: true + allOf: + - $ref: '#/components/schemas/Client.PublicUserData' + factor_verification_age: + type: array + description: Each item represents the minutes that have passed since the last time a first or second factor were verified. + items: + type: integer + created_at: + type: integer + format: int64 + description: Unix timestamp of creation. + example: 1700690400000 + updated_at: + type: integer + format: int64 + description: Unix timestamp of last update. + example: 1700690400000 + required: + - last_active_organization_id + - public_user_data + - factor_verification_age + - created_at + - updated_at + schemas-Client.Client: + type: object + nullable: true + properties: + object: + type: string + description: String representing the object's type. Objects of the same type share the same value. + enum: + - client + id: + type: string + description: String representing the identifier of the session. + sessions: + type: array + items: + $ref: '#/components/schemas/schemas-Client.Session' + sign_in: + type: object + nullable: true + allOf: + - $ref: '#/components/schemas/Client.SignIn' + sign_up: + type: object + nullable: true + allOf: + - $ref: '#/components/schemas/Client.SignUp' + last_active_session_id: + nullable: true + type: string + description: Last active session_id. + cookie_expires_at: + nullable: true + type: integer + format: int64 + description: Unix timestamp of the cookie expiration. + captcha_bypass: + type: boolean + description: Whether the client can bypass CAPTCHA. + created_at: + type: integer + format: int64 + description: Unix timestamp of creation. + updated_at: + type: integer + format: int64 + description: Unix timestamp of last update. + required: + - object + - id + - sessions + - sign_in + - sign_up + - last_active_session_id + - cookie_expires_at + - captcha_bypass + - created_at + - updated_at + schemas-Client.ClientWrappedSignIn: + type: object + additionalProperties: false + properties: + response: + $ref: '#/components/schemas/Client.SignIn' + client: + $ref: '#/components/schemas/schemas-Client.Client' + required: + - response + - client Client.ClientWrappedSignUp: type: object additionalProperties: false @@ -8037,7 +8140,24 @@ components: response: $ref: '#/components/schemas/Image' client: - $ref: '#/components/schemas/Client.Client' + $ref: '#/components/schemas/schemas-Client.Client' + required: + - response + - client + schemas-Client.ClientWrappedUser: + type: object + additionalProperties: false + properties: + response: + type: object + nullable: false + allOf: + - $ref: '#/components/schemas/Client.User' + client: + type: object + nullable: false + allOf: + - $ref: '#/components/schemas/schemas-Client.Client' required: - response - client @@ -8281,6 +8401,23 @@ components: required: - response - client + schemas-Client.ClientWrappedOrganization: + type: object + additionalProperties: false + properties: + response: + type: object + nullable: false + allOf: + - $ref: '#/components/schemas/Client.Organization' + client: + type: object + nullable: false + allOf: + - $ref: '#/components/schemas/schemas-Client.Client' + required: + - response + - client Client.ClientWrappedOrganizationInvitations: type: object additionalProperties: false @@ -8714,6 +8851,12 @@ components: application/json: schema: $ref: '#/components/schemas/Client.ClientWrappedSignIn' + responses-Client.SignIn: + description: Returns the sign in object, as well as the updated session object. + content: + application/json: + schema: + $ref: '#/components/schemas/schemas-Client.ClientWrappedSignIn' Client.SignUp: description: Returns the sign up object, as well as the updated session object. content: @@ -8852,6 +8995,12 @@ components: application/json: schema: $ref: '#/components/schemas/Client.ClientWrappedImage' + responses-Client.ClientWrappedUser: + description: Returns the response for Session wrapped User object. + content: + application/json: + schema: + $ref: '#/components/schemas/schemas-Client.ClientWrappedUser' Client.ClientWrappedOrganizationMemberships: description: Returns the response for Client wrapped array of OrganizationMembership objects. content: @@ -8888,6 +9037,12 @@ components: application/json: schema: $ref: '#/components/schemas/Client.ClientWrappedOrganization' + responses-Client.ClientWrappedOrganization: + description: Returns the response for Client wrapped Organization object. + content: + application/json: + schema: + $ref: '#/components/schemas/schemas-Client.ClientWrappedOrganization' Client.ClientWrappedOrganizationInvitations: description: Returns the response for Client wrapped array of OrganizationInvitation objects. content: