diff --git a/bapi/2021-02-05.yml b/bapi/2021-02-05.yml index 31a2b26..5f0e781 100644 --- a/bapi/2021-02-05.yml +++ b/bapi/2021-02-05.yml @@ -134,6 +134,8 @@ paths: The Clerk interstitial endpoint serves an html page that loads clerk.js in order to check the user's authentication state. It is used by Clerk SDKs when the user's authentication state cannot be immediately determined. operationId: GetPublicInterstitial + x-sdk-ruby-operationGroup: miscellaneous + x-sdk-ruby-operationId: get_interstitial tags: - Miscellaneous parameters: @@ -159,6 +161,8 @@ paths: /jwks: get: operationId: GetJWKS + x-sdk-ruby-operationGroup: jwks + x-sdk-ruby-operationId: get summary: Retrieve the JSON Web Key Set of the instance description: Retrieve the JSON Web Key Set of the instance tags: @@ -170,6 +174,8 @@ paths: get: deprecated: true operationId: GetClientList + x-sdk-ruby-operationGroup: clients + x-sdk-ruby-operationId: all tags: - Clients summary: List all clients @@ -194,6 +200,8 @@ paths: /clients/verify: post: operationId: VerifyClient + x-sdk-ruby-operationGroup: clients + x-sdk-ruby-operationId: verify tags: - Clients summary: Verify a client @@ -221,6 +229,8 @@ paths: /clients/{client_id}: get: operationId: GetClient + x-sdk-ruby-operationGroup: clients + x-sdk-ruby-operationId: find tags: - Clients summary: Get a client @@ -244,6 +254,8 @@ paths: /email_addresses: post: operationId: CreateEmailAddress + x-sdk-ruby-operationGroup: email_addresses + x-sdk-ruby-operationId: create tags: - Email Addresses summary: Create an email address @@ -286,6 +298,8 @@ paths: /email_addresses/{email_address_id}: get: operationId: GetEmailAddress + x-sdk-ruby-operationGroup: email_addresses + x-sdk-ruby-operationId: find tags: - Email Addresses summary: Retrieve an email address @@ -310,6 +324,8 @@ paths: $ref: '#/components/responses/ResourceNotFound' delete: operationId: DeleteEmailAddress + x-sdk-ruby-operationGroup: email_addresses + x-sdk-ruby-operationId: delete tags: - Email Addresses summary: Delete an email address @@ -334,6 +350,8 @@ paths: $ref: '#/components/responses/ResourceNotFound' patch: operationId: UpdateEmailAddress + x-sdk-ruby-operationGroup: email_addresses + x-sdk-ruby-operationId: update tags: - Email Addresses summary: Update an email address @@ -373,6 +391,8 @@ paths: /phone_numbers: post: operationId: CreatePhoneNumber + x-sdk-ruby-operationGroup: phone_numbers + x-sdk-ruby-operationId: create tags: - Phone Numbers summary: Create a phone number @@ -422,6 +442,8 @@ paths: /phone_numbers/{phone_number_id}: get: operationId: GetPhoneNumber + x-sdk-ruby-operationGroup: phone_numbers + x-sdk-ruby-operationId: find tags: - Phone Numbers summary: Retrieve a phone number @@ -446,6 +468,8 @@ paths: $ref: '#/components/responses/ResourceNotFound' delete: operationId: DeletePhoneNumber + x-sdk-ruby-operationGroup: phone_numbers + x-sdk-ruby-operationId: delete tags: - Phone Numbers summary: Delete a phone number @@ -470,6 +494,8 @@ paths: $ref: '#/components/responses/ResourceNotFound' patch: operationId: UpdatePhoneNumber + x-sdk-ruby-operationGroup: phone_numbers + x-sdk-ruby-operationId: update tags: - Phone Numbers summary: Update a phone number @@ -516,6 +542,8 @@ paths: /sessions: get: operationId: GetSessionList + x-sdk-ruby-operationGroup: sessions + x-sdk-ruby-operationId: all tags: - Sessions summary: List all sessions @@ -565,6 +593,8 @@ paths: /sessions/{session_id}: get: operationId: GetSession + x-sdk-ruby-operationGroup: sessions + x-sdk-ruby-operationId: find tags: - Sessions summary: Retrieve a session @@ -588,6 +618,8 @@ paths: /sessions/{session_id}/revoke: post: operationId: RevokeSession + x-sdk-ruby-operationGroup: sessions + x-sdk-ruby-operationId: revoke tags: - Sessions summary: Revoke a session @@ -614,6 +646,8 @@ paths: post: deprecated: true operationId: VerifySession + x-sdk-ruby-operationGroup: sessions + x-sdk-ruby-operationId: verify tags: - Sessions summary: Verify a session @@ -656,6 +690,8 @@ paths: /sessions/{session_id}/tokens/{template_name}: post: operationId: CreateSessionTokenFromTemplate + x-sdk-ruby-operationGroup: sessions + x-sdk-ruby-operationId: create_from_template tags: - Sessions summary: Create a session token from a jwt template @@ -695,6 +731,8 @@ paths: get: deprecated: true operationId: GetTemplateList + x-sdk-ruby-operationGroup: templates + x-sdk-ruby-operationId: all summary: List all templates description: |- Returns a list of all templates. @@ -724,6 +762,8 @@ paths: get: deprecated: true operationId: GetTemplate + x-sdk-ruby-operationGroup: templates + x-sdk-ruby-operationId: find summary: Retrieve a template description: Returns the details of a template tags: @@ -756,6 +796,8 @@ paths: put: deprecated: true operationId: UpsertTemplate + x-sdk-ruby-operationGroup: templates + x-sdk-ruby-operationId: update summary: Update a template for a given type and slug description: Updates the existing template of the given type and slug tags: @@ -834,6 +876,8 @@ paths: post: deprecated: true operationId: RevertTemplate + x-sdk-ruby-operationGroup: templates + x-sdk-ruby-operationId: revert summary: Revert a template description: Reverts an updated template to its default state tags: @@ -869,6 +913,8 @@ paths: post: deprecated: true operationId: PreviewTemplate + x-sdk-ruby-operationGroup: templates + x-sdk-ruby-operationId: preview summary: Preview changes to a template description: Returns a preview of a template for a given template_type, slug and body tags: @@ -934,6 +980,8 @@ paths: post: deprecated: true operationId: ToggleTemplateDelivery + x-sdk-ruby-operationGroup: templates + x-sdk-ruby-operationId: toggle_delivery summary: Toggle the delivery by Clerk for a template of a given type and slug description: |- Toggles the delivery by Clerk for a template of a given type and slug. @@ -980,6 +1028,8 @@ paths: /users: get: operationId: GetUserList + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: all summary: List all users description: |- Returns a list of all users. @@ -1120,6 +1170,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' post: operationId: CreateUser + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: create summary: Create a new user description: |- Creates a new user. Your user management settings determine how you should setup your user model. @@ -1277,6 +1329,8 @@ paths: /users/count: get: operationId: GetUsersCount + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: count summary: Count users description: Returns a total count of all users that match the given filtering criteria. tags: @@ -1365,6 +1419,8 @@ paths: /users/{user_id}: get: operationId: GetUser + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: find summary: Retrieve a user description: Retrieve the details of a user tags: @@ -1387,6 +1443,8 @@ paths: $ref: '#/components/responses/ResourceNotFound' patch: operationId: UpdateUser + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: update summary: Update a user description: |- Update a user's attributes. @@ -1549,6 +1607,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' delete: operationId: DeleteUser + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: delete summary: Delete a user description: Delete the specified user tags: @@ -1572,6 +1632,8 @@ paths: /users/{user_id}/ban: post: operationId: BanUser + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: ban summary: Ban a user description: Marks the given user as banned, which means that all their sessions are revoked and they are not allowed to sign in again. tags: @@ -1591,6 +1653,8 @@ paths: /users/{user_id}/unban: post: operationId: UnbanUser + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: unban summary: Unban a user description: Removes the ban mark from the given user. tags: @@ -1610,6 +1674,8 @@ paths: /users/{user_id}/lock: post: operationId: LockUser + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: lock summary: Lock a user description: |- Marks the given user as locked, which means they are not allowed to sign in again until the lock expires. @@ -1631,6 +1697,8 @@ paths: /users/{user_id}/unlock: post: operationId: UnlockUser + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: unlock summary: Unlock a user description: Removes the lock from the given user. tags: @@ -1650,6 +1718,8 @@ paths: /users/{user_id}/profile_image: post: operationId: SetUserProfileImage + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: update_profile_image summary: Set user profile image description: Update a user's profile image tags: @@ -1682,6 +1752,8 @@ paths: $ref: '#/components/responses/ClerkErrors' delete: operationId: DeleteUserProfileImage + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: delete_profile_image summary: Delete user profile image description: Delete a user's profile image tags: @@ -1701,6 +1773,8 @@ paths: /users/{user_id}/metadata: patch: operationId: UpdateUserMetadata + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: update_metadata summary: Merge and update a user's metadata description: |- Update a user's metadata attributes by merging existing values with the provided parameters. @@ -1761,6 +1835,8 @@ paths: /users/{user_id}/oauth_access_tokens/{provider}: get: operationId: GetOAuthAccessToken + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: oauth_access_token summary: Retrieve the OAuth access token of a user description: |- Fetch the corresponding OAuth access token for a user that has previously authenticated with a particular OAuth provider. @@ -1827,6 +1903,8 @@ paths: /users/{user_id}/organization_memberships: get: operationId: UsersGetOrganizationMemberships + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: organization_memberships summary: Retrieve all memberships for a user description: Retrieve a paginated list of the user's organization memberships tags: @@ -1848,6 +1926,8 @@ paths: /users/{user_id}/organization_invitations: get: operationId: UsersGetOrganizationInvitations + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: organization_invitations summary: Retrieve all invitations for a user description: Retrieve a paginated list of the user's organization invitations tags: @@ -1883,6 +1963,8 @@ paths: /users/{user_id}/verify_password: post: operationId: VerifyPassword + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: verify_password summary: Verify the password of a user description: |- Check that the user's password matches the supplied input. @@ -1931,6 +2013,8 @@ paths: /users/{user_id}/verify_totp: post: operationId: VerifyTOTP + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: verify_totp summary: Verify a TOTP or backup code for a user description: |- Verify that the provided TOTP or backup code is valid for the user. @@ -1987,6 +2071,8 @@ paths: /users/{user_id}/mfa: delete: operationId: DisableMFA + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: disable_mfa summary: Disable a user's MFA methods description: Disable all of a user's MFA methods (e.g. OTP sent via SMS, TOTP on their authenticator app) at once. tags: @@ -2017,6 +2103,8 @@ paths: /users/{user_id}/backup_code: delete: operationId: DeleteBackupCode + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: delete_backup_code summary: Disable all user's Backup codes description: Disable all of a user's backup codes. tags: @@ -2047,6 +2135,8 @@ paths: /users/{user_id}/passkeys/{passkey_identification_id}: delete: operationId: UserPasskeyDelete + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: delete_passkey summary: Delete a user passkey description: Delete the passkey identification for a given user and notify them through email. tags: @@ -2076,6 +2166,8 @@ paths: /users/{user_id}/web3_wallets/{web3_wallet_identification_id}: delete: operationId: UserWeb3WalletDelete + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: delete_web3_wallet summary: Delete a user web3 wallet description: Delete the web3 wallet identification for a given user. tags: @@ -2107,6 +2199,8 @@ paths: /users/{user_id}/totp: post: operationId: CreateUserTOTP + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: create_totp summary: Create a TOTP for a user description: | Creates a TOTP (Time-based One-Time Password) for a given user, returning both the TOTP secret and the URI. @@ -2160,6 +2254,8 @@ paths: /users/{user_id}/external_accounts/{external_account_id}: delete: operationId: DeleteExternalAccount + x-sdk-ruby-operationGroup: users + x-sdk-ruby-operationId: delete_external_account summary: Delete External Account description: Delete an external account by ID. tags: @@ -2191,6 +2287,8 @@ paths: /invitations: post: operationId: CreateInvitation + x-sdk-ruby-operationGroup: invitations + x-sdk-ruby-operationId: create summary: Create an invitation description: |- Creates a new invitation for the given email address and sends the invitation email. @@ -2251,6 +2349,8 @@ paths: summary: List all invitations description: Returns all non-revoked invitations for your application, sorted by creation date operationId: ListInvitations + x-sdk-ruby-operationGroup: invitations + x-sdk-ruby-operationId: all parameters: - $ref: '#/components/parameters/LimitParameter' - $ref: '#/components/parameters/OffsetParameter' @@ -2273,6 +2373,8 @@ paths: /invitations/{invitation_id}/revoke: post: operationId: RevokeInvitation + x-sdk-ruby-operationGroup: invitations + x-sdk-ruby-operationId: revoke summary: Revokes an invitation description: |- Revokes the given invitation. @@ -2298,6 +2400,8 @@ paths: /organization_invitations: get: operationId: ListInstanceOrganizationInvitations + x-sdk-ruby-operationGroup: organization_invitations + x-sdk-ruby-operationId: all summary: Get a list of organization invitations for the current instance description: |- This request returns the list of organization invitations for the instance. @@ -2354,6 +2458,8 @@ paths: /allowlist_identifiers: get: operationId: ListAllowlistIdentifiers + x-sdk-ruby-operationGroup: allowlist_identifiers + x-sdk-ruby-operationId: all summary: List all identifiers on the allow-list description: Get a list of all identifiers allowed to sign up to an instance tags: @@ -2367,6 +2473,8 @@ paths: $ref: '#/components/responses/PaymentRequired' post: operationId: CreateAllowlistIdentifier + x-sdk-ruby-operationGroup: allowlist_identifiers + x-sdk-ruby-operationId: create summary: Add identifier to the allow-list description: Create an identifier allowed to sign up to an instance tags: @@ -2403,6 +2511,8 @@ paths: /allowlist_identifiers/{identifier_id}: delete: operationId: DeleteAllowlistIdentifier + x-sdk-ruby-operationGroup: allowlist_identifiers + x-sdk-ruby-operationId: delete summary: Delete identifier from allow-list description: Delete an identifier from the instance allow-list tags: @@ -2424,6 +2534,8 @@ paths: /blocklist_identifiers: get: operationId: ListBlocklistIdentifiers + x-sdk-ruby-operationGroup: blocklist_identifiers + x-sdk-ruby-operationId: all summary: List all identifiers on the block-list description: Get a list of all identifiers which are not allowed to access an instance tags: @@ -2437,6 +2549,8 @@ paths: $ref: '#/components/responses/PaymentRequired' post: operationId: CreateBlocklistIdentifier + x-sdk-ruby-operationGroup: blocklist_identifiers + x-sdk-ruby-operationId: create summary: Add identifier to the block-list description: Create an identifier that is blocked from accessing an instance tags: @@ -2467,6 +2581,8 @@ paths: /blocklist_identifiers/{identifier_id}: delete: operationId: DeleteBlocklistIdentifier + x-sdk-ruby-operationGroup: blocklist_identifiers + x-sdk-ruby-operationId: delete summary: Delete identifier from block-list description: Delete an identifier from the instance block-list tags: @@ -2488,6 +2604,8 @@ paths: /beta_features/instance_settings: patch: operationId: UpdateInstanceAuthConfig + x-sdk-ruby-operationGroup: beta_features + x-sdk-ruby-operationId: update_instance_settings summary: Update instance settings description: Updates the settings of an instance tags: @@ -2542,6 +2660,8 @@ paths: put: deprecated: true operationId: UpdateProductionInstanceDomain + x-sdk-ruby-operationGroup: beta_features + x-sdk-ruby-operationId: update_production_instance_domain summary: Update production instance domain description: |- Change the domain of a production instance. @@ -2575,6 +2695,8 @@ paths: Create an actor token that can be used to impersonate the given user. The `actor` parameter needs to include at least a "sub" key whose value is the ID of the actor (impersonating) user. operationId: CreateActorToken + x-sdk-ruby-operationGroup: actor_tokens + x-sdk-ruby-operationId: create tags: - Actor Tokens requestBody: @@ -2623,6 +2745,8 @@ paths: summary: Revoke actor token description: Revokes a pending actor token. operationId: RevokeActorToken + x-sdk-ruby-operationGroup: actor_tokens + x-sdk-ruby-operationId: revoke tags: - Actor Tokens parameters: @@ -2646,6 +2770,8 @@ paths: Use this endpoint to get a list of all domains for an instance. The response will contain the primary domain for the instance and any satellite domains. Each domain in the response contains information about the URLs where Clerk operates and the required CNAME targets. operationId: ListDomains + x-sdk-ruby-operationGroup: domains + x-sdk-ruby-operationId: all tags: - Domains responses: @@ -2660,6 +2786,8 @@ paths: At the moment, instances can have only one primary domain, so the `is_satellite` parameter must be set to `true`. If you're planning to configure the new satellite domain to run behind a proxy, pass the `proxy_url` parameter accordingly. operationId: AddDomain + x-sdk-ruby-operationGroup: domains + x-sdk-ruby-operationId: create tags: - Domains requestBody: @@ -2694,6 +2822,8 @@ paths: /domains/{domain_id}: delete: operationId: DeleteDomain + x-sdk-ruby-operationGroup: domains + x-sdk-ruby-operationId: delete summary: Delete a satellite domain description: |- Deletes a satellite domain for the instance. @@ -2716,6 +2846,8 @@ paths: $ref: '#/components/responses/ResourceNotFound' patch: operationId: UpdateDomain + x-sdk-ruby-operationGroup: domains + x-sdk-ruby-operationId: update summary: Update a domain description: |- The `proxy_url` can be updated only for production instances. @@ -2775,6 +2907,8 @@ paths: /instance: patch: operationId: UpdateInstance + x-sdk-ruby-operationGroup: instance + x-sdk-ruby-operationId: update summary: Update instance settings description: Updates the settings of an instance tags: @@ -2835,6 +2969,8 @@ paths: /instance/restrictions: patch: operationId: UpdateInstanceRestrictions + x-sdk-ruby-operationGroup: instance + x-sdk-ruby-operationId: update_restrictions summary: Update instance restrictions description: Updates the restriction settings of an instance tags: @@ -2871,6 +3007,8 @@ paths: /instance/change_domain: post: operationId: ChangeProductionInstanceDomain + x-sdk-ruby-operationGroup: instance + x-sdk-ruby-operationId: update_production_domain summary: Update production instance domain description: |- Change the domain of a production instance. @@ -2906,6 +3044,8 @@ paths: /instance/organization_settings: patch: operationId: UpdateInstanceOrganizationSettings + x-sdk-ruby-operationGroup: instance + x-sdk-ruby-operationId: update_organization_settings summary: Update instance organization settings description: Updates the organization settings of the instance tags: @@ -2954,6 +3094,8 @@ paths: /webhooks/svix: post: operationId: CreateSvixApp + x-sdk-ruby-operationGroup: webhooks + x-sdk-ruby-operationId: create summary: Create a Svix app description: Create a Svix app and associate it with the current instance tags: @@ -2965,6 +3107,8 @@ paths: $ref: '#/components/responses/ClerkErrors' delete: operationId: DeleteSvixApp + x-sdk-ruby-operationGroup: webhooks + x-sdk-ruby-operationId: delete summary: Delete a Svix app description: Delete a Svix app and disassociate it from the current instance tags: @@ -2977,6 +3121,8 @@ paths: /webhooks/svix_url: post: operationId: GenerateSvixAuthURL + x-sdk-ruby-operationGroup: webhooks + x-sdk-ruby-operationId: generate_auth_url summary: Create a Svix Dashboard URL description: Generate a new url for accessing the Svix's management dashboard for that particular instance tags: @@ -2990,6 +3136,8 @@ paths: get: summary: List all templates operationId: ListJWTTemplates + x-sdk-ruby-operationGroup: jwt_templates + x-sdk-ruby-operationId: all tags: - JWT Templates responses: @@ -2997,6 +3145,8 @@ paths: $ref: '#/components/responses/JWTTemplate.List' post: operationId: CreateJWTTemplate + x-sdk-ruby-operationGroup: jwt_templates + x-sdk-ruby-operationId: create summary: Create a JWT template description: Create a new JWT template tags: @@ -3051,6 +3201,8 @@ paths: /jwt_templates/{template_id}: get: operationId: GetJWTTemplate + x-sdk-ruby-operationGroup: jwt_templates + x-sdk-ruby-operationId: find summary: Retrieve a template description: Retrieve the details of a given JWT template tags: @@ -3069,6 +3221,8 @@ paths: $ref: '#/components/responses/ResourceNotFound' patch: operationId: UpdateJWTTemplate + x-sdk-ruby-operationGroup: jwt_templates + x-sdk-ruby-operationId: update summary: Update a JWT template description: Updates an existing JWT template tags: @@ -3129,6 +3283,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' delete: operationId: DeleteJWTTemplate + x-sdk-ruby-operationGroup: jwt_templates + x-sdk-ruby-operationId: delete summary: Delete a Template description: '' tags: @@ -3150,6 +3306,8 @@ paths: /organizations: get: operationId: ListOrganizations + x-sdk-ruby-operationGroup: organizations + x-sdk-ruby-operationId: all summary: Get a list of organizations for an instance description: |- This request returns the list of organizations for an instance. @@ -3199,6 +3357,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' post: operationId: CreateOrganization + x-sdk-ruby-operationGroup: organizations + x-sdk-ruby-operationId: create summary: Create an organization description: |- Creates a new organization with the given name for an instance. @@ -3261,6 +3421,8 @@ paths: /organizations/{organization_id}: get: operationId: GetOrganization + x-sdk-ruby-operationGroup: organizations + x-sdk-ruby-operationId: find summary: Retrieve an organization by ID or slug description: Fetches the organization whose ID or slug matches the provided `id_or_slug` URL query parameter. tags: @@ -3287,6 +3449,8 @@ paths: $ref: '#/components/responses/ResourceNotFound' patch: operationId: UpdateOrganization + x-sdk-ruby-operationGroup: organizations + x-sdk-ruby-operationId: update summary: Update an organization description: Updates an existing organization tags: @@ -3344,6 +3508,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' delete: operationId: DeleteOrganization + x-sdk-ruby-operationGroup: organizations + x-sdk-ruby-operationId: delete summary: Delete an organization description: |- Deletes the given organization. @@ -3366,6 +3532,8 @@ paths: /organizations/{organization_id}/metadata: patch: operationId: MergeOrganizationMetadata + x-sdk-ruby-operationGroup: organizations + x-sdk-ruby-operationId: merge_metadata summary: Merge and update metadata for an organization description: |- Update organization metadata attributes by merging existing values with the provided parameters. @@ -3413,6 +3581,8 @@ paths: /organizations/{organization_id}/logo: put: operationId: UploadOrganizationLogo + x-sdk-ruby-operationGroup: organizations + x-sdk-ruby-operationId: update_logo summary: Upload a logo for the organization description: |- Set or replace an organization's logo, by uploading an image file. @@ -3455,6 +3625,8 @@ paths: $ref: '#/components/responses/ClerkErrors' delete: operationId: DeleteOrganizationLogo + x-sdk-ruby-operationGroup: organizations + x-sdk-ruby-operationId: delete_logo description: Delete the organization's logo. tags: - Organizations @@ -3473,6 +3645,8 @@ paths: /organizations/{organization_id}/invitations: post: operationId: CreateOrganizationInvitation + x-sdk-ruby-operationGroup: organization_invitations + x-sdk-ruby-operationId: create summary: Create and send an organization invitation description: |- Creates a new organization invitation and sends an email to the provided `email_address` with a link to accept the invitation and join the organization. @@ -3544,6 +3718,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' get: operationId: ListOrganizationInvitations + x-sdk-ruby-operationGroup: organization_invitations + x-sdk-ruby-operationId: all summary: Get a list of organization invitations description: |- This request returns the list of organization invitations. @@ -3583,6 +3759,8 @@ paths: /organizations/{organization_id}/invitations/bulk: post: operationId: CreateOrganizationInvitationBulk + x-sdk-ruby-operationGroup: organization_invitations + x-sdk-ruby-operationId: create_bulk summary: Bulk create and send organization invitations description: |- Creates new organization invitations in bulk and sends out emails to the provided email addresses with a link to accept the invitation and join the organization. @@ -3655,6 +3833,8 @@ paths: get: deprecated: true operationId: ListPendingOrganizationInvitations + x-sdk-ruby-operationGroup: organization_invitations + x-sdk-ruby-operationId: pending summary: Get a list of pending organization invitations description: |- This request returns the list of organization invitations with "pending" status. @@ -3684,6 +3864,8 @@ paths: /organizations/{organization_id}/invitations/{invitation_id}: get: operationId: GetOrganizationInvitation + x-sdk-ruby-operationGroup: organization_invitations + x-sdk-ruby-operationId: find summary: Retrieve an organization invitation by ID description: Use this request to get an existing organization invitation by ID. tags: @@ -3713,6 +3895,8 @@ paths: /organizations/{organization_id}/invitations/{invitation_id}/revoke: post: operationId: RevokeOrganizationInvitation + x-sdk-ruby-operationGroup: organization_invitations + x-sdk-ruby-operationId: revoke summary: Revoke a pending organization invitation description: |- Use this request to revoke a previously issued organization invitation. @@ -3760,6 +3944,8 @@ paths: /organizations/{organization_id}/memberships: post: operationId: CreateOrganizationMembership + x-sdk-ruby-operationGroup: organization_memberships + x-sdk-ruby-operationId: create summary: Create a new organization membership description: |- Adds a user as a member to the given organization. @@ -3808,6 +3994,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' get: operationId: ListOrganizationMemberships + x-sdk-ruby-operationGroup: organization_memberships + x-sdk-ruby-operationId: all_by_organization summary: Get a list of all members of an organization description: Retrieves all user memberships for the given organization tags: @@ -3840,6 +4028,8 @@ paths: /organizations/{organization_id}/memberships/{user_id}: patch: operationId: UpdateOrganizationMembership + x-sdk-ruby-operationGroup: organization_memberships + x-sdk-ruby-operationId: update summary: Update an organization membership description: Updates the properties of an existing organization membership tags: @@ -3880,6 +4070,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' delete: operationId: DeleteOrganizationMembership + x-sdk-ruby-operationGroup: organization_memberships + x-sdk-ruby-operationId: delete summary: Remove a member from an organization description: Removes the given membership from the organization tags: @@ -3909,6 +4101,8 @@ paths: /organizations/{organization_id}/memberships/{user_id}/metadata: patch: operationId: UpdateOrganizationMembershipMetadata + x-sdk-ruby-operationGroup: organization_memberships + x-sdk-ruby-operationId: update_metadata summary: Merge and update organization membership metadata description: |- Update an organization membership's metadata attributes by merging existing values with the provided parameters. @@ -3959,6 +4153,8 @@ paths: /organizations/{organization_id}/domains: post: operationId: CreateOrganizationDomain + x-sdk-ruby-operationGroup: organization_domains + x-sdk-ruby-operationId: create summary: Create a new organization domain. description: Creates a new organization domain. By default the domain is verified, but can be optionally set to unverified. tags: @@ -4003,6 +4199,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' get: operationId: ListOrganizationDomains + x-sdk-ruby-operationGroup: organization_domains + x-sdk-ruby-operationId: all summary: Get a list of all domains of an organization. description: Get a list of all domains of an organization. tags: @@ -4038,6 +4236,8 @@ paths: /organizations/{organization_id}/domains/{domain_id}: patch: operationId: UpdateOrganizationDomain + x-sdk-ruby-operationGroup: organization_domains + x-sdk-ruby-operationId: update summary: Update an organization domain. description: Updates the properties of an existing organization domain. tags: @@ -4081,6 +4281,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' delete: operationId: DeleteOrganizationDomain + x-sdk-ruby-operationGroup: organization_domains + x-sdk-ruby-operationId: delete summary: Remove a domain from an organization. description: Removes the given domain from the organization. tags: @@ -4120,6 +4322,8 @@ paths: The `proxy_url` parameter allows for testing proxy configurations for domains that don't have a proxy URL yet, or operate on a different proxy URL than the one provided. It can also be used to re-validate a domain that is already configured to work with a proxy. operationId: VerifyDomainProxy + x-sdk-ruby-operationGroup: proxy_checks + x-sdk-ruby-operationId: verify tags: - Proxy checks requestBody: @@ -4146,6 +4350,8 @@ paths: summary: List all redirect URLs description: Lists all whitelisted redirect_urls for the instance operationId: ListRedirectURLs + x-sdk-ruby-operationGroup: redirect_urls + x-sdk-ruby-operationId: all tags: - Redirect URLs responses: @@ -4155,6 +4361,8 @@ paths: summary: Create a redirect URL description: Create a redirect URL operationId: CreateRedirectURL + x-sdk-ruby-operationGroup: redirect_urls + x-sdk-ruby-operationId: create tags: - Redirect URLs requestBody: @@ -4179,6 +4387,8 @@ paths: summary: Retrieve a redirect URL description: Retrieve the details of the redirect URL with the given ID operationId: GetRedirectURL + x-sdk-ruby-operationGroup: redirect_urls + x-sdk-ruby-operationId: find tags: - Redirect URLs parameters: @@ -4197,6 +4407,8 @@ paths: summary: Delete a redirect URL description: Remove the selected redirect URL from the whitelist of the instance operationId: DeleteRedirectURL + x-sdk-ruby-operationGroup: redirect_urls + x-sdk-ruby-operationId: delete tags: - Redirect URLs parameters: @@ -4219,6 +4431,8 @@ paths: By default, sign-in tokens expire in 30 days. You can optionally supply a different duration in seconds using the `expires_in_seconds` property. operationId: CreateSignInToken + x-sdk-ruby-operationGroup: sign_in_tokens + x-sdk-ruby-operationId: create tags: - Sign-in Tokens requestBody: @@ -4248,6 +4462,8 @@ paths: summary: Revoke the given sign-in token description: Revokes a pending sign-in token operationId: RevokeSignInToken + x-sdk-ruby-operationGroup: sign_in_tokens + x-sdk-ruby-operationId: revoke tags: - Sign-in Tokens parameters: @@ -4267,6 +4483,8 @@ paths: /sign_ups/{id}: patch: operationId: UpdateSignUp + x-sdk-ruby-operationGroup: sign_ups + x-sdk-ruby-operationId: update summary: Update a sign-up description: Update the sign-up with the given ID tags: @@ -4298,6 +4516,8 @@ paths: /oauth_applications: get: operationId: ListOAuthApplications + x-sdk-ruby-operationGroup: oauth_applications + x-sdk-ruby-operationId: all summary: Get a list of OAuth applications for an instance description: |- This request returns the list of OAuth applications for an instance. @@ -4320,6 +4540,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' post: operationId: CreateOAuthApplication + x-sdk-ruby-operationGroup: oauth_applications + x-sdk-ruby-operationId: create summary: Create an OAuth application description: |- Creates a new OAuth application with the given name and callback URL for an instance. @@ -4365,6 +4587,8 @@ paths: /oauth_applications/{oauth_application_id}: get: operationId: GetOAuthApplication + x-sdk-ruby-operationGroup: oauth_applications + x-sdk-ruby-operationId: find summary: Retrieve an OAuth application by ID description: Fetches the OAuth application whose ID matches the provided `id` in the path. tags: @@ -4385,6 +4609,8 @@ paths: $ref: '#/components/responses/ResourceNotFound' patch: operationId: UpdateOAuthApplication + x-sdk-ruby-operationGroup: oauth_applications + x-sdk-ruby-operationId: update summary: Update an OAuth application description: Updates an existing OAuth application tags: @@ -4426,6 +4652,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' delete: operationId: DeleteOAuthApplication + x-sdk-ruby-operationGroup: oauth_applications + x-sdk-ruby-operationId: delete summary: Delete an OAuth application description: |- Deletes the given OAuth application. @@ -4449,6 +4677,8 @@ paths: /oauth_applications/{oauth_application_id}/rotate_secret: post: operationId: RotateOAuthApplicationSecret + x-sdk-ruby-operationGroup: oauth_applications + x-sdk-ruby-operationId: rotate_secret summary: Rotate the client secret of the given OAuth application description: |- Rotates the OAuth application's client secret. @@ -4472,6 +4702,8 @@ paths: /saml_connections: get: operationId: ListSAMLConnections + x-sdk-ruby-operationGroup: saml_connections + x-sdk-ruby-operationId: all summary: Get a list of SAML Connections for an instance description: |- Returns the list of SAML Connections for an instance. @@ -4493,6 +4725,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' post: operationId: CreateSAMLConnection + x-sdk-ruby-operationGroup: saml_connections + x-sdk-ruby-operationId: create summary: Create a SAML Connection description: Create a new SAML Connection. tags: @@ -4568,6 +4802,8 @@ paths: /saml_connections/{saml_connection_id}: get: operationId: GetSAMLConnection + x-sdk-ruby-operationGroup: saml_connections + x-sdk-ruby-operationId: find summary: Retrieve a SAML Connection by ID description: Fetches the SAML Connection whose ID matches the provided `saml_connection_id` in the path. tags: @@ -4590,6 +4826,8 @@ paths: $ref: '#/components/responses/ResourceNotFound' patch: operationId: UpdateSAMLConnection + x-sdk-ruby-operationGroup: saml_connections + x-sdk-ruby-operationId: update summary: Update a SAML Connection description: Updates the SAML Connection whose ID matches the provided `id` in the path. tags: @@ -4684,6 +4922,8 @@ paths: $ref: '#/components/responses/UnprocessableEntity' delete: operationId: DeleteSAMLConnection + x-sdk-ruby-operationGroup: saml_connections + x-sdk-ruby-operationId: delete summary: Delete a SAML Connection description: Deletes the SAML Connection whose ID matches the provided `id` in the path. tags: @@ -4707,6 +4947,8 @@ paths: /testing_tokens: post: operationId: CreateTestingToken + x-sdk-ruby-operationGroup: testing_tokens + x-sdk-ruby-operationId: create summary: Retrieve a new testing token description: Retrieve a new testing token. Only available for development instances. tags: @@ -4719,6 +4961,8 @@ paths: /organization_memberships: get: operationId: InstanceGetOrganizationMemberships + x-sdk-ruby-operationGroup: organization_memberships + x-sdk-ruby-operationId: all summary: Get a list of all organization memberships within an instance. description: Retrieves all organization user memberships for the given instance. tags: