diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 87473c3..f0d539c 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 1d22a5a4-8bac-42e3-b164-121fcacf66c9 management: - docChecksum: f6e25376d224dc39635a7f5eed081de2 + docChecksum: 360e2b992ec7b171685132d827f3b1f7 docVersion: v1 - speakeasyVersion: 1.390.1 - generationVersion: 2.409.0 - releaseVersion: 0.3.0-beta.3 - configChecksum: 457823c8a9591ad2fc26d7cbfd0453a1 + speakeasyVersion: 1.385.0 + generationVersion: 2.407.2 + releaseVersion: 0.3.0-beta.4 + configChecksum: b0df6ba5eac8f8909dc3ed95a3f66438 repoURL: https://github.com/clerk/clerk-sdk-java.git published: true features: @@ -24,7 +24,6 @@ features: groups: 2.81.2 nameOverrides: 2.81.3 nullables: 0.1.0 - pagination: 0.2.2 sdkHooks: 0.1.0 unions: 0.0.5 generatedFiles: @@ -36,24 +35,31 @@ generatedFiles: - src/main/java/com/clerk/backend_api/EmailAddresses.java - src/main/java/com/clerk/backend_api/PhoneNumbers.java - src/main/java/com/clerk/backend_api/Sessions.java + - src/main/java/com/clerk/backend_api/EmailSMSTemplates.java + - src/main/java/com/clerk/backend_api/EmailAndSmsTemplates.java - src/main/java/com/clerk/backend_api/Templates.java - src/main/java/com/clerk/backend_api/Users.java - src/main/java/com/clerk/backend_api/Invitations.java - - src/main/java/com/clerk/backend_api/Allowlist.java - - src/main/java/com/clerk/backend_api/Blocklist.java - - src/main/java/com/clerk/backend_api/Instance.java - - src/main/java/com/clerk/backend_api/Actors.java + - src/main/java/com/clerk/backend_api/OrganizationInvitations.java + - src/main/java/com/clerk/backend_api/AllowlistBlocklist.java + - src/main/java/com/clerk/backend_api/AllowlistIdentifiers.java + - src/main/java/com/clerk/backend_api/BlocklistIdentifiers.java + - src/main/java/com/clerk/backend_api/BetaFeatures.java + - src/main/java/com/clerk/backend_api/ActorTokens.java - src/main/java/com/clerk/backend_api/Domains.java + - src/main/java/com/clerk/backend_api/InstanceSettings.java - src/main/java/com/clerk/backend_api/Webhooks.java - src/main/java/com/clerk/backend_api/JwtTemplates.java - src/main/java/com/clerk/backend_api/Organizations.java - - src/main/java/com/clerk/backend_api/OrganizationInvitations.java - src/main/java/com/clerk/backend_api/OrganizationMemberships.java - - src/main/java/com/clerk/backend_api/Proxy.java + - src/main/java/com/clerk/backend_api/OrganizationDomains.java + - src/main/java/com/clerk/backend_api/OrganizationDomain.java + - src/main/java/com/clerk/backend_api/ProxyChecks.java - src/main/java/com/clerk/backend_api/RedirectURLs.java + - src/main/java/com/clerk/backend_api/ClerkRedirectUrls.java - src/main/java/com/clerk/backend_api/SignInTokens.java - src/main/java/com/clerk/backend_api/SignUps.java - - src/main/java/com/clerk/backend_api/OAuthApplications.java + - src/main/java/com/clerk/backend_api/OauthApplications.java - src/main/java/com/clerk/backend_api/SamlConnections.java - src/main/java/com/clerk/backend_api/TestingTokens.java - src/main/java/com/clerk/backend_api/models/operations/GetPublicInterstitialRequestBuilder.java @@ -74,12 +80,10 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/operations/RevokeSessionRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/VerifySessionRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/CreateSessionTokenFromTemplateRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/GetTemplateListRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/GetTemplateRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/ToggleTemplateDeliveryRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/UpsertTemplateRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/RevertTemplateRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/PreviewTemplateRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/ToggleTemplateDeliveryRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/GetUserListRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/CreateUserRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/GetUsersCountRequestBuilder.java @@ -95,30 +99,44 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/operations/UpdateUserMetadataRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/GetOAuthAccessTokenRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/UsersGetOrganizationMembershipsRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/UsersGetOrganizationInvitationsRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/VerifyPasswordRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/VerifyTOTPRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/DisableMFARequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteBackupCodeRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/UserPasskeyDeleteRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/UserWeb3WalletDeleteRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/CreateUserTOTPRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteTOTPRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteExternalAccountRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/CreateInvitationRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/ListInvitationsRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/RevokeInvitationRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/ListInstanceOrganizationInvitationsRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/ListOrganizationInvitationsRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationBulkRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/ListPendingOrganizationInvitationsRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/GetOrganizationInvitationRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/RevokeOrganizationInvitationRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/ListAllowlistIdentifiersRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/CreateAllowlistIdentifierRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/DeleteAllowlistIdentifierRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/ListBlocklistIdentifiersRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/CreateBlocklistIdentifierRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/DeleteBlocklistIdentifierRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteAllowlistIdentifierRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/ListBlocklistIdentifiersRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceAuthConfigRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/UpdateProductionInstanceDomainRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceRestrictionsRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/ChangeProductionInstanceDomainRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceOrganizationSettingsRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/CreateActorTokenRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/RevokeActorTokenRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/ListDomainsRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/AddDomainRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/DeleteDomainRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/UpdateDomainRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceRestrictionsRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceOrganizationSettingsRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/CreateSvixAppRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/DeleteSvixAppRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/GenerateSvixAuthURLRequestBuilder.java @@ -135,17 +153,16 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/operations/MergeOrganizationMetadataRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/UploadOrganizationLogoRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/DeleteOrganizationLogoRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/ListOrganizationInvitationsRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationBulkRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/ListPendingOrganizationInvitationsRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/GetOrganizationInvitationRequestBuilder.java - - src/main/java/com/clerk/backend_api/models/operations/RevokeOrganizationInvitationRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationMembershipRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/ListOrganizationMembershipsRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/UpdateOrganizationMembershipRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/DeleteOrganizationMembershipRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/UpdateOrganizationMembershipMetadataRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/InstanceGetOrganizationMembershipsRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationDomainRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/ListOrganizationDomainsRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteOrganizationDomainRequestBuilder.java + - src/main/java/com/clerk/backend_api/models/operations/UpdateOrganizationDomainRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/VerifyDomainProxyRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/ListRedirectURLsRequestBuilder.java - src/main/java/com/clerk/backend_api/models/operations/CreateRedirectURLRequestBuilder.java @@ -255,30 +272,23 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/operations/Object.java - src/main/java/com/clerk/backend_api/models/operations/CreateSessionTokenFromTemplateResponseBody.java - src/main/java/com/clerk/backend_api/models/operations/CreateSessionTokenFromTemplateResponse.java - - src/main/java/com/clerk/backend_api/models/operations/TemplateType.java - - src/main/java/com/clerk/backend_api/models/operations/GetTemplateListRequest.java - - src/main/java/com/clerk/backend_api/models/operations/GetTemplateListResponse.java - src/main/java/com/clerk/backend_api/models/operations/PathParamTemplateType.java - src/main/java/com/clerk/backend_api/models/operations/GetTemplateRequest.java - src/main/java/com/clerk/backend_api/models/operations/GetTemplateResponse.java + - src/main/java/com/clerk/backend_api/models/operations/ToggleTemplateDeliveryPathParamTemplateType.java + - src/main/java/com/clerk/backend_api/models/operations/ToggleTemplateDeliveryRequestBody.java + - src/main/java/com/clerk/backend_api/models/operations/ToggleTemplateDeliveryRequest.java + - src/main/java/com/clerk/backend_api/models/operations/ToggleTemplateDeliveryResponse.java - src/main/java/com/clerk/backend_api/models/operations/UpsertTemplatePathParamTemplateType.java - src/main/java/com/clerk/backend_api/models/operations/UpsertTemplateRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/UpsertTemplateRequest.java - src/main/java/com/clerk/backend_api/models/operations/UpsertTemplateResponse.java - - src/main/java/com/clerk/backend_api/models/operations/RevertTemplatePathParamTemplateType.java - - src/main/java/com/clerk/backend_api/models/operations/RevertTemplateRequest.java - - src/main/java/com/clerk/backend_api/models/operations/RevertTemplateResponse.java - src/main/java/com/clerk/backend_api/models/operations/PreviewTemplateRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/PreviewTemplateRequest.java - src/main/java/com/clerk/backend_api/models/operations/PreviewTemplateResponseBody.java - src/main/java/com/clerk/backend_api/models/operations/PreviewTemplateResponse.java - - src/main/java/com/clerk/backend_api/models/operations/ToggleTemplateDeliveryPathParamTemplateType.java - - src/main/java/com/clerk/backend_api/models/operations/ToggleTemplateDeliveryRequestBody.java - - src/main/java/com/clerk/backend_api/models/operations/ToggleTemplateDeliveryRequest.java - - src/main/java/com/clerk/backend_api/models/operations/ToggleTemplateDeliveryResponse.java - src/main/java/com/clerk/backend_api/models/operations/GetUserListRequest.java - src/main/java/com/clerk/backend_api/models/operations/GetUserListResponse.java - - src/main/java/com/clerk/backend_api/models/operations/PasswordHasher.java - src/main/java/com/clerk/backend_api/models/operations/PublicMetadata.java - src/main/java/com/clerk/backend_api/models/operations/PrivateMetadata.java - src/main/java/com/clerk/backend_api/models/operations/UnsafeMetadata.java @@ -288,7 +298,6 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/operations/GetUsersCountResponse.java - src/main/java/com/clerk/backend_api/models/operations/GetUserRequest.java - src/main/java/com/clerk/backend_api/models/operations/GetUserResponse.java - - src/main/java/com/clerk/backend_api/models/operations/UpdateUserPasswordHasher.java - src/main/java/com/clerk/backend_api/models/operations/UpdateUserPublicMetadata.java - src/main/java/com/clerk/backend_api/models/operations/UpdateUserPrivateMetadata.java - src/main/java/com/clerk/backend_api/models/operations/UpdateUserUnsafeMetadata.java @@ -311,9 +320,6 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/operations/SetUserProfileImageResponse.java - src/main/java/com/clerk/backend_api/models/operations/DeleteUserProfileImageRequest.java - src/main/java/com/clerk/backend_api/models/operations/DeleteUserProfileImageResponse.java - - src/main/java/com/clerk/backend_api/models/operations/UpdateUserMetadataPublicMetadata.java - - src/main/java/com/clerk/backend_api/models/operations/UpdateUserMetadataPrivateMetadata.java - - src/main/java/com/clerk/backend_api/models/operations/UpdateUserMetadataUnsafeMetadata.java - src/main/java/com/clerk/backend_api/models/operations/UpdateUserMetadataRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/UpdateUserMetadataRequest.java - src/main/java/com/clerk/backend_api/models/operations/UpdateUserMetadataResponse.java @@ -323,6 +329,9 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/operations/GetOAuthAccessTokenResponse.java - src/main/java/com/clerk/backend_api/models/operations/UsersGetOrganizationMembershipsRequest.java - src/main/java/com/clerk/backend_api/models/operations/UsersGetOrganizationMembershipsResponse.java + - src/main/java/com/clerk/backend_api/models/operations/QueryParamStatus.java + - src/main/java/com/clerk/backend_api/models/operations/UsersGetOrganizationInvitationsRequest.java + - src/main/java/com/clerk/backend_api/models/operations/UsersGetOrganizationInvitationsResponse.java - src/main/java/com/clerk/backend_api/models/operations/VerifyPasswordRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/VerifyPasswordRequest.java - src/main/java/com/clerk/backend_api/models/operations/VerifyPasswordResponseBody.java @@ -335,36 +344,68 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/operations/DisableMFARequest.java - src/main/java/com/clerk/backend_api/models/operations/DisableMFAResponseBody.java - src/main/java/com/clerk/backend_api/models/operations/DisableMFAResponse.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteBackupCodeRequest.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteBackupCodeResponseBody.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteBackupCodeResponse.java + - src/main/java/com/clerk/backend_api/models/operations/UserPasskeyDeleteRequest.java + - src/main/java/com/clerk/backend_api/models/operations/UserPasskeyDeleteResponse.java + - src/main/java/com/clerk/backend_api/models/operations/UserWeb3WalletDeleteRequest.java + - src/main/java/com/clerk/backend_api/models/operations/UserWeb3WalletDeleteResponse.java + - src/main/java/com/clerk/backend_api/models/operations/CreateUserTOTPRequest.java + - src/main/java/com/clerk/backend_api/models/operations/CreateUserTOTPResponse.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteTOTPRequest.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteTOTPResponseBody.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteTOTPResponse.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteExternalAccountRequest.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteExternalAccountResponse.java - src/main/java/com/clerk/backend_api/models/operations/CreateInvitationPublicMetadata.java - src/main/java/com/clerk/backend_api/models/operations/CreateInvitationRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/CreateInvitationResponse.java - - src/main/java/com/clerk/backend_api/models/operations/QueryParamStatus.java + - src/main/java/com/clerk/backend_api/models/operations/ListInvitationsQueryParamStatus.java - src/main/java/com/clerk/backend_api/models/operations/ListInvitationsRequest.java - src/main/java/com/clerk/backend_api/models/operations/ListInvitationsResponse.java - src/main/java/com/clerk/backend_api/models/operations/RevokeInvitationRequest.java - src/main/java/com/clerk/backend_api/models/operations/RevokeInvitationResponse.java + - src/main/java/com/clerk/backend_api/models/operations/ListInstanceOrganizationInvitationsQueryParamStatus.java + - src/main/java/com/clerk/backend_api/models/operations/ListInstanceOrganizationInvitationsRequest.java + - src/main/java/com/clerk/backend_api/models/operations/ListInstanceOrganizationInvitationsResponse.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationPublicMetadata.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationPrivateMetadata.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationRequestBody.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationRequest.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationResponse.java + - src/main/java/com/clerk/backend_api/models/operations/ListOrganizationInvitationsQueryParamStatus.java + - src/main/java/com/clerk/backend_api/models/operations/ListOrganizationInvitationsRequest.java + - src/main/java/com/clerk/backend_api/models/operations/ListOrganizationInvitationsResponse.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationBulkPublicMetadata.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationBulkPrivateMetadata.java + - src/main/java/com/clerk/backend_api/models/operations/RequestBody.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationBulkRequest.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationBulkResponse.java + - src/main/java/com/clerk/backend_api/models/operations/ListPendingOrganizationInvitationsRequest.java + - src/main/java/com/clerk/backend_api/models/operations/ListPendingOrganizationInvitationsResponse.java + - src/main/java/com/clerk/backend_api/models/operations/GetOrganizationInvitationRequest.java + - src/main/java/com/clerk/backend_api/models/operations/GetOrganizationInvitationResponse.java + - src/main/java/com/clerk/backend_api/models/operations/RevokeOrganizationInvitationRequestBody.java + - src/main/java/com/clerk/backend_api/models/operations/RevokeOrganizationInvitationRequest.java + - src/main/java/com/clerk/backend_api/models/operations/RevokeOrganizationInvitationResponse.java - src/main/java/com/clerk/backend_api/models/operations/ListAllowlistIdentifiersResponse.java - src/main/java/com/clerk/backend_api/models/operations/CreateAllowlistIdentifierRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/CreateAllowlistIdentifierResponse.java - - src/main/java/com/clerk/backend_api/models/operations/DeleteAllowlistIdentifierRequest.java - - src/main/java/com/clerk/backend_api/models/operations/DeleteAllowlistIdentifierResponse.java - - src/main/java/com/clerk/backend_api/models/operations/ListBlocklistIdentifiersResponse.java - src/main/java/com/clerk/backend_api/models/operations/CreateBlocklistIdentifierRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/CreateBlocklistIdentifierResponse.java - src/main/java/com/clerk/backend_api/models/operations/DeleteBlocklistIdentifierRequest.java - src/main/java/com/clerk/backend_api/models/operations/DeleteBlocklistIdentifierResponse.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteAllowlistIdentifierRequest.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteAllowlistIdentifierResponse.java + - src/main/java/com/clerk/backend_api/models/operations/ListBlocklistIdentifiersResponse.java - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceAuthConfigRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceAuthConfigResponse.java - src/main/java/com/clerk/backend_api/models/operations/UpdateProductionInstanceDomainRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/UpdateProductionInstanceDomainResponse.java - - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceRequestBody.java - - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceResponse.java - - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceRestrictionsRequestBody.java - - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceRestrictionsResponse.java - src/main/java/com/clerk/backend_api/models/operations/ChangeProductionInstanceDomainRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/ChangeProductionInstanceDomainResponse.java - - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceOrganizationSettingsRequestBody.java - - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceOrganizationSettingsResponse.java + - src/main/java/com/clerk/backend_api/models/operations/Actor.java - src/main/java/com/clerk/backend_api/models/operations/CreateActorTokenRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/CreateActorTokenResponse.java - src/main/java/com/clerk/backend_api/models/operations/RevokeActorTokenRequest.java @@ -377,6 +418,12 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/operations/UpdateDomainRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/UpdateDomainRequest.java - src/main/java/com/clerk/backend_api/models/operations/UpdateDomainResponse.java + - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceRequestBody.java + - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceResponse.java + - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceRestrictionsRequestBody.java + - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceRestrictionsResponse.java + - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceOrganizationSettingsRequestBody.java + - src/main/java/com/clerk/backend_api/models/operations/UpdateInstanceOrganizationSettingsResponse.java - src/main/java/com/clerk/backend_api/models/operations/CreateSvixAppResponse.java - src/main/java/com/clerk/backend_api/models/operations/DeleteSvixAppResponse.java - src/main/java/com/clerk/backend_api/models/operations/GenerateSvixAuthURLResponse.java @@ -418,26 +465,6 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/operations/UploadOrganizationLogoResponse.java - src/main/java/com/clerk/backend_api/models/operations/DeleteOrganizationLogoRequest.java - src/main/java/com/clerk/backend_api/models/operations/DeleteOrganizationLogoResponse.java - - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationPublicMetadata.java - - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationPrivateMetadata.java - - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationRequestBody.java - - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationRequest.java - - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationResponse.java - - src/main/java/com/clerk/backend_api/models/operations/ListOrganizationInvitationsQueryParamStatus.java - - src/main/java/com/clerk/backend_api/models/operations/ListOrganizationInvitationsRequest.java - - src/main/java/com/clerk/backend_api/models/operations/ListOrganizationInvitationsResponse.java - - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationBulkPublicMetadata.java - - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationBulkPrivateMetadata.java - - src/main/java/com/clerk/backend_api/models/operations/RequestBody.java - - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationBulkRequest.java - - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationInvitationBulkResponse.java - - src/main/java/com/clerk/backend_api/models/operations/ListPendingOrganizationInvitationsRequest.java - - src/main/java/com/clerk/backend_api/models/operations/ListPendingOrganizationInvitationsResponse.java - - src/main/java/com/clerk/backend_api/models/operations/GetOrganizationInvitationRequest.java - - src/main/java/com/clerk/backend_api/models/operations/GetOrganizationInvitationResponse.java - - src/main/java/com/clerk/backend_api/models/operations/RevokeOrganizationInvitationRequestBody.java - - src/main/java/com/clerk/backend_api/models/operations/RevokeOrganizationInvitationRequest.java - - src/main/java/com/clerk/backend_api/models/operations/RevokeOrganizationInvitationResponse.java - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationMembershipRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationMembershipRequest.java - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationMembershipResponse.java @@ -453,6 +480,18 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/operations/UpdateOrganizationMembershipMetadataRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/UpdateOrganizationMembershipMetadataRequest.java - src/main/java/com/clerk/backend_api/models/operations/UpdateOrganizationMembershipMetadataResponse.java + - src/main/java/com/clerk/backend_api/models/operations/InstanceGetOrganizationMembershipsRequest.java + - src/main/java/com/clerk/backend_api/models/operations/InstanceGetOrganizationMembershipsResponse.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationDomainRequestBody.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationDomainRequest.java + - src/main/java/com/clerk/backend_api/models/operations/CreateOrganizationDomainResponse.java + - src/main/java/com/clerk/backend_api/models/operations/ListOrganizationDomainsRequest.java + - src/main/java/com/clerk/backend_api/models/operations/ListOrganizationDomainsResponse.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteOrganizationDomainRequest.java + - src/main/java/com/clerk/backend_api/models/operations/DeleteOrganizationDomainResponse.java + - src/main/java/com/clerk/backend_api/models/operations/UpdateOrganizationDomainRequestBody.java + - src/main/java/com/clerk/backend_api/models/operations/UpdateOrganizationDomainRequest.java + - src/main/java/com/clerk/backend_api/models/operations/UpdateOrganizationDomainResponse.java - src/main/java/com/clerk/backend_api/models/operations/VerifyDomainProxyRequestBody.java - src/main/java/com/clerk/backend_api/models/operations/VerifyDomainProxyResponse.java - src/main/java/com/clerk/backend_api/models/operations/ListRedirectURLsResponse.java @@ -497,11 +536,14 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/operations/DeleteSAMLConnectionRequest.java - src/main/java/com/clerk/backend_api/models/operations/DeleteSAMLConnectionResponse.java - src/main/java/com/clerk/backend_api/models/operations/CreateTestingTokenResponse.java + - src/main/java/com/clerk/backend_api/models/components/Keys.java + - src/main/java/com/clerk/backend_api/models/components/WellKnownJWKS.java - src/main/java/com/clerk/backend_api/models/components/Object.java - src/main/java/com/clerk/backend_api/models/components/Client.java - src/main/java/com/clerk/backend_api/models/components/SessionObject.java - src/main/java/com/clerk/backend_api/models/components/Actor.java - src/main/java/com/clerk/backend_api/models/components/Status.java + - src/main/java/com/clerk/backend_api/models/components/LatestActivity.java - src/main/java/com/clerk/backend_api/models/components/Session.java - src/main/java/com/clerk/backend_api/models/components/Meta.java - src/main/java/com/clerk/backend_api/models/components/ClerkError.java @@ -552,11 +594,13 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/components/VerificationError.java - src/main/java/com/clerk/backend_api/models/components/Saml.java - src/main/java/com/clerk/backend_api/models/components/SAMLAccountVerification.java + - src/main/java/com/clerk/backend_api/models/components/SAMLConnectionSAMLConnection.java + - src/main/java/com/clerk/backend_api/models/components/SamlConnection.java - src/main/java/com/clerk/backend_api/models/components/SAMLAccount.java - src/main/java/com/clerk/backend_api/models/components/SchemasPasskeyObject.java - src/main/java/com/clerk/backend_api/models/components/PasskeyVerificationStatus.java - src/main/java/com/clerk/backend_api/models/components/PasskeyVerificationStrategy.java - - src/main/java/com/clerk/backend_api/models/components/VerificationNonce.java + - src/main/java/com/clerk/backend_api/models/components/Nonce.java - src/main/java/com/clerk/backend_api/models/components/Passkey.java - src/main/java/com/clerk/backend_api/models/components/SchemasPasskeyVerification.java - src/main/java/com/clerk/backend_api/models/components/SchemasPasskey.java @@ -566,7 +610,6 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/components/Web3WalletVerificationAdmin.java - src/main/java/com/clerk/backend_api/models/components/Web3SignatureVerificationStatus.java - src/main/java/com/clerk/backend_api/models/components/Web3SignatureVerificationStrategy.java - - src/main/java/com/clerk/backend_api/models/components/Nonce.java - src/main/java/com/clerk/backend_api/models/components/Web3Signature.java - src/main/java/com/clerk/backend_api/models/components/Web3WalletVerification.java - src/main/java/com/clerk/backend_api/models/components/Web3Wallet.java @@ -582,6 +625,12 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/components/OrganizationMembershipOrganization.java - src/main/java/com/clerk/backend_api/models/components/PublicUserData.java - src/main/java/com/clerk/backend_api/models/components/OrganizationMembership.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitationsWithPublicOrganizationData.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitationWithPublicOrganizationDataObject.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitationWithPublicOrganizationDataPublicMetadata.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitationWithPublicOrganizationDataPrivateMetadata.java + - src/main/java/com/clerk/backend_api/models/components/PublicOrganizationData.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitationWithPublicOrganizationData.java - src/main/java/com/clerk/backend_api/models/components/InvitationObject.java - src/main/java/com/clerk/backend_api/models/components/InvitationPublicMetadata.java - src/main/java/com/clerk/backend_api/models/components/InvitationStatus.java @@ -590,20 +639,20 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/components/InvitationRevokedPublicMetadata.java - src/main/java/com/clerk/backend_api/models/components/InvitationRevokedStatus.java - src/main/java/com/clerk/backend_api/models/components/InvitationRevoked.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitationObject.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitationPublicMetadata.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitationPrivateMetadata.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitation.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitations.java - src/main/java/com/clerk/backend_api/models/components/AllowlistIdentifierObject.java - src/main/java/com/clerk/backend_api/models/components/IdentifierType.java - src/main/java/com/clerk/backend_api/models/components/AllowlistIdentifier.java - - src/main/java/com/clerk/backend_api/models/components/BlocklistIdentifiers.java - src/main/java/com/clerk/backend_api/models/components/BlocklistIdentifierObject.java - src/main/java/com/clerk/backend_api/models/components/BlocklistIdentifierIdentifierType.java - src/main/java/com/clerk/backend_api/models/components/BlocklistIdentifier.java + - src/main/java/com/clerk/backend_api/models/components/BlocklistIdentifiers.java - src/main/java/com/clerk/backend_api/models/components/InstanceSettingsObject.java - src/main/java/com/clerk/backend_api/models/components/InstanceSettings.java - - src/main/java/com/clerk/backend_api/models/components/InstanceRestrictionsObject.java - - src/main/java/com/clerk/backend_api/models/components/InstanceRestrictions.java - - src/main/java/com/clerk/backend_api/models/components/OrganizationSettingsObject.java - - src/main/java/com/clerk/backend_api/models/components/DomainsEnrollmentModes.java - - src/main/java/com/clerk/backend_api/models/components/OrganizationSettings.java - src/main/java/com/clerk/backend_api/models/components/ActorTokenObject.java - src/main/java/com/clerk/backend_api/models/components/ActorTokenStatus.java - src/main/java/com/clerk/backend_api/models/components/ActorTokenActor.java @@ -612,6 +661,11 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/components/DomainObject.java - src/main/java/com/clerk/backend_api/models/components/Domain.java - src/main/java/com/clerk/backend_api/models/components/CNameTarget.java + - src/main/java/com/clerk/backend_api/models/components/InstanceRestrictionsObject.java + - src/main/java/com/clerk/backend_api/models/components/InstanceRestrictions.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationSettingsObject.java + - src/main/java/com/clerk/backend_api/models/components/DomainsEnrollmentModes.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationSettings.java - src/main/java/com/clerk/backend_api/models/components/SvixURL.java - src/main/java/com/clerk/backend_api/models/components/JWTTemplateObject.java - src/main/java/com/clerk/backend_api/models/components/Claims.java @@ -625,11 +679,12 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/components/OrganizationWithLogoPublicMetadata.java - src/main/java/com/clerk/backend_api/models/components/OrganizationWithLogoPrivateMetadata.java - src/main/java/com/clerk/backend_api/models/components/OrganizationWithLogo.java - - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitationObject.java - - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitationPublicMetadata.java - - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitationPrivateMetadata.java - - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitation.java - - src/main/java/com/clerk/backend_api/models/components/OrganizationInvitations.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationDomainObject.java + - src/main/java/com/clerk/backend_api/models/components/EnrollmentMode.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationDomainStatus.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationDomainVerification.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationDomain.java + - src/main/java/com/clerk/backend_api/models/components/OrganizationDomains.java - src/main/java/com/clerk/backend_api/models/components/ProxyCheckObject.java - src/main/java/com/clerk/backend_api/models/components/ProxyCheck.java - src/main/java/com/clerk/backend_api/models/components/RedirectURLObject.java @@ -650,9 +705,9 @@ generatedFiles: - src/main/java/com/clerk/backend_api/models/components/OAuthApplicationWithSecretObject.java - src/main/java/com/clerk/backend_api/models/components/OAuthApplicationWithSecret.java - src/main/java/com/clerk/backend_api/models/components/SAMLConnections.java - - src/main/java/com/clerk/backend_api/models/components/SAMLConnectionObject.java + - src/main/java/com/clerk/backend_api/models/components/SchemasSAMLConnectionObject.java - src/main/java/com/clerk/backend_api/models/components/AttributeMapping.java - - src/main/java/com/clerk/backend_api/models/components/SAMLConnection.java + - src/main/java/com/clerk/backend_api/models/components/SchemasSAMLConnection.java - src/main/java/com/clerk/backend_api/models/components/TestingTokenObject.java - src/main/java/com/clerk/backend_api/models/components/TestingToken.java - src/main/java/com/clerk/backend_api/models/components/Security.java @@ -699,30 +754,23 @@ generatedFiles: - docs/models/operations/Object.md - docs/models/operations/CreateSessionTokenFromTemplateResponseBody.md - docs/models/operations/CreateSessionTokenFromTemplateResponse.md - - docs/models/operations/TemplateType.md - - docs/models/operations/GetTemplateListRequest.md - - docs/models/operations/GetTemplateListResponse.md - docs/models/operations/PathParamTemplateType.md - docs/models/operations/GetTemplateRequest.md - docs/models/operations/GetTemplateResponse.md + - docs/models/operations/ToggleTemplateDeliveryPathParamTemplateType.md + - docs/models/operations/ToggleTemplateDeliveryRequestBody.md + - docs/models/operations/ToggleTemplateDeliveryRequest.md + - docs/models/operations/ToggleTemplateDeliveryResponse.md - docs/models/operations/UpsertTemplatePathParamTemplateType.md - docs/models/operations/UpsertTemplateRequestBody.md - docs/models/operations/UpsertTemplateRequest.md - docs/models/operations/UpsertTemplateResponse.md - - docs/models/operations/RevertTemplatePathParamTemplateType.md - - docs/models/operations/RevertTemplateRequest.md - - docs/models/operations/RevertTemplateResponse.md - docs/models/operations/PreviewTemplateRequestBody.md - docs/models/operations/PreviewTemplateRequest.md - docs/models/operations/PreviewTemplateResponseBody.md - docs/models/operations/PreviewTemplateResponse.md - - docs/models/operations/ToggleTemplateDeliveryPathParamTemplateType.md - - docs/models/operations/ToggleTemplateDeliveryRequestBody.md - - docs/models/operations/ToggleTemplateDeliveryRequest.md - - docs/models/operations/ToggleTemplateDeliveryResponse.md - docs/models/operations/GetUserListRequest.md - docs/models/operations/GetUserListResponse.md - - docs/models/operations/PasswordHasher.md - docs/models/operations/PublicMetadata.md - docs/models/operations/PrivateMetadata.md - docs/models/operations/UnsafeMetadata.md @@ -732,7 +780,6 @@ generatedFiles: - docs/models/operations/GetUsersCountResponse.md - docs/models/operations/GetUserRequest.md - docs/models/operations/GetUserResponse.md - - docs/models/operations/UpdateUserPasswordHasher.md - docs/models/operations/UpdateUserPublicMetadata.md - docs/models/operations/UpdateUserPrivateMetadata.md - docs/models/operations/UpdateUserUnsafeMetadata.md @@ -755,9 +802,6 @@ generatedFiles: - docs/models/operations/SetUserProfileImageResponse.md - docs/models/operations/DeleteUserProfileImageRequest.md - docs/models/operations/DeleteUserProfileImageResponse.md - - docs/models/operations/UpdateUserMetadataPublicMetadata.md - - docs/models/operations/UpdateUserMetadataPrivateMetadata.md - - docs/models/operations/UpdateUserMetadataUnsafeMetadata.md - docs/models/operations/UpdateUserMetadataRequestBody.md - docs/models/operations/UpdateUserMetadataRequest.md - docs/models/operations/UpdateUserMetadataResponse.md @@ -767,6 +811,9 @@ generatedFiles: - docs/models/operations/GetOAuthAccessTokenResponse.md - docs/models/operations/UsersGetOrganizationMembershipsRequest.md - docs/models/operations/UsersGetOrganizationMembershipsResponse.md + - docs/models/operations/QueryParamStatus.md + - docs/models/operations/UsersGetOrganizationInvitationsRequest.md + - docs/models/operations/UsersGetOrganizationInvitationsResponse.md - docs/models/operations/VerifyPasswordRequestBody.md - docs/models/operations/VerifyPasswordRequest.md - docs/models/operations/VerifyPasswordResponseBody.md @@ -779,36 +826,68 @@ generatedFiles: - docs/models/operations/DisableMFARequest.md - docs/models/operations/DisableMFAResponseBody.md - docs/models/operations/DisableMFAResponse.md + - docs/models/operations/DeleteBackupCodeRequest.md + - docs/models/operations/DeleteBackupCodeResponseBody.md + - docs/models/operations/DeleteBackupCodeResponse.md + - docs/models/operations/UserPasskeyDeleteRequest.md + - docs/models/operations/UserPasskeyDeleteResponse.md + - docs/models/operations/UserWeb3WalletDeleteRequest.md + - docs/models/operations/UserWeb3WalletDeleteResponse.md + - docs/models/operations/CreateUserTOTPRequest.md + - docs/models/operations/CreateUserTOTPResponse.md + - docs/models/operations/DeleteTOTPRequest.md + - docs/models/operations/DeleteTOTPResponseBody.md + - docs/models/operations/DeleteTOTPResponse.md + - docs/models/operations/DeleteExternalAccountRequest.md + - docs/models/operations/DeleteExternalAccountResponse.md - docs/models/operations/CreateInvitationPublicMetadata.md - docs/models/operations/CreateInvitationRequestBody.md - docs/models/operations/CreateInvitationResponse.md - - docs/models/operations/QueryParamStatus.md + - docs/models/operations/ListInvitationsQueryParamStatus.md - docs/models/operations/ListInvitationsRequest.md - docs/models/operations/ListInvitationsResponse.md - docs/models/operations/RevokeInvitationRequest.md - docs/models/operations/RevokeInvitationResponse.md + - docs/models/operations/ListInstanceOrganizationInvitationsQueryParamStatus.md + - docs/models/operations/ListInstanceOrganizationInvitationsRequest.md + - docs/models/operations/ListInstanceOrganizationInvitationsResponse.md + - docs/models/operations/CreateOrganizationInvitationPublicMetadata.md + - docs/models/operations/CreateOrganizationInvitationPrivateMetadata.md + - docs/models/operations/CreateOrganizationInvitationRequestBody.md + - docs/models/operations/CreateOrganizationInvitationRequest.md + - docs/models/operations/CreateOrganizationInvitationResponse.md + - docs/models/operations/ListOrganizationInvitationsQueryParamStatus.md + - docs/models/operations/ListOrganizationInvitationsRequest.md + - docs/models/operations/ListOrganizationInvitationsResponse.md + - docs/models/operations/CreateOrganizationInvitationBulkPublicMetadata.md + - docs/models/operations/CreateOrganizationInvitationBulkPrivateMetadata.md + - docs/models/operations/RequestBody.md + - docs/models/operations/CreateOrganizationInvitationBulkRequest.md + - docs/models/operations/CreateOrganizationInvitationBulkResponse.md + - docs/models/operations/ListPendingOrganizationInvitationsRequest.md + - docs/models/operations/ListPendingOrganizationInvitationsResponse.md + - docs/models/operations/GetOrganizationInvitationRequest.md + - docs/models/operations/GetOrganizationInvitationResponse.md + - docs/models/operations/RevokeOrganizationInvitationRequestBody.md + - docs/models/operations/RevokeOrganizationInvitationRequest.md + - docs/models/operations/RevokeOrganizationInvitationResponse.md - docs/models/operations/ListAllowlistIdentifiersResponse.md - docs/models/operations/CreateAllowlistIdentifierRequestBody.md - docs/models/operations/CreateAllowlistIdentifierResponse.md - - docs/models/operations/DeleteAllowlistIdentifierRequest.md - - docs/models/operations/DeleteAllowlistIdentifierResponse.md - - docs/models/operations/ListBlocklistIdentifiersResponse.md - docs/models/operations/CreateBlocklistIdentifierRequestBody.md - docs/models/operations/CreateBlocklistIdentifierResponse.md - docs/models/operations/DeleteBlocklistIdentifierRequest.md - docs/models/operations/DeleteBlocklistIdentifierResponse.md + - docs/models/operations/DeleteAllowlistIdentifierRequest.md + - docs/models/operations/DeleteAllowlistIdentifierResponse.md + - docs/models/operations/ListBlocklistIdentifiersResponse.md - docs/models/operations/UpdateInstanceAuthConfigRequestBody.md - docs/models/operations/UpdateInstanceAuthConfigResponse.md - docs/models/operations/UpdateProductionInstanceDomainRequestBody.md - docs/models/operations/UpdateProductionInstanceDomainResponse.md - - docs/models/operations/UpdateInstanceRequestBody.md - - docs/models/operations/UpdateInstanceResponse.md - - docs/models/operations/UpdateInstanceRestrictionsRequestBody.md - - docs/models/operations/UpdateInstanceRestrictionsResponse.md - docs/models/operations/ChangeProductionInstanceDomainRequestBody.md - docs/models/operations/ChangeProductionInstanceDomainResponse.md - - docs/models/operations/UpdateInstanceOrganizationSettingsRequestBody.md - - docs/models/operations/UpdateInstanceOrganizationSettingsResponse.md + - docs/models/operations/Actor.md - docs/models/operations/CreateActorTokenRequestBody.md - docs/models/operations/CreateActorTokenResponse.md - docs/models/operations/RevokeActorTokenRequest.md @@ -821,6 +900,12 @@ generatedFiles: - docs/models/operations/UpdateDomainRequestBody.md - docs/models/operations/UpdateDomainRequest.md - docs/models/operations/UpdateDomainResponse.md + - docs/models/operations/UpdateInstanceRequestBody.md + - docs/models/operations/UpdateInstanceResponse.md + - docs/models/operations/UpdateInstanceRestrictionsRequestBody.md + - docs/models/operations/UpdateInstanceRestrictionsResponse.md + - docs/models/operations/UpdateInstanceOrganizationSettingsRequestBody.md + - docs/models/operations/UpdateInstanceOrganizationSettingsResponse.md - docs/models/operations/CreateSvixAppResponse.md - docs/models/operations/DeleteSvixAppResponse.md - docs/models/operations/GenerateSvixAuthURLResponse.md @@ -862,26 +947,6 @@ generatedFiles: - docs/models/operations/UploadOrganizationLogoResponse.md - docs/models/operations/DeleteOrganizationLogoRequest.md - docs/models/operations/DeleteOrganizationLogoResponse.md - - docs/models/operations/CreateOrganizationInvitationPublicMetadata.md - - docs/models/operations/CreateOrganizationInvitationPrivateMetadata.md - - docs/models/operations/CreateOrganizationInvitationRequestBody.md - - docs/models/operations/CreateOrganizationInvitationRequest.md - - docs/models/operations/CreateOrganizationInvitationResponse.md - - docs/models/operations/ListOrganizationInvitationsQueryParamStatus.md - - docs/models/operations/ListOrganizationInvitationsRequest.md - - docs/models/operations/ListOrganizationInvitationsResponse.md - - docs/models/operations/CreateOrganizationInvitationBulkPublicMetadata.md - - docs/models/operations/CreateOrganizationInvitationBulkPrivateMetadata.md - - docs/models/operations/RequestBody.md - - docs/models/operations/CreateOrganizationInvitationBulkRequest.md - - docs/models/operations/CreateOrganizationInvitationBulkResponse.md - - docs/models/operations/ListPendingOrganizationInvitationsRequest.md - - docs/models/operations/ListPendingOrganizationInvitationsResponse.md - - docs/models/operations/GetOrganizationInvitationRequest.md - - docs/models/operations/GetOrganizationInvitationResponse.md - - docs/models/operations/RevokeOrganizationInvitationRequestBody.md - - docs/models/operations/RevokeOrganizationInvitationRequest.md - - docs/models/operations/RevokeOrganizationInvitationResponse.md - docs/models/operations/CreateOrganizationMembershipRequestBody.md - docs/models/operations/CreateOrganizationMembershipRequest.md - docs/models/operations/CreateOrganizationMembershipResponse.md @@ -897,6 +962,18 @@ generatedFiles: - docs/models/operations/UpdateOrganizationMembershipMetadataRequestBody.md - docs/models/operations/UpdateOrganizationMembershipMetadataRequest.md - docs/models/operations/UpdateOrganizationMembershipMetadataResponse.md + - docs/models/operations/InstanceGetOrganizationMembershipsRequest.md + - docs/models/operations/InstanceGetOrganizationMembershipsResponse.md + - docs/models/operations/CreateOrganizationDomainRequestBody.md + - docs/models/operations/CreateOrganizationDomainRequest.md + - docs/models/operations/CreateOrganizationDomainResponse.md + - docs/models/operations/ListOrganizationDomainsRequest.md + - docs/models/operations/ListOrganizationDomainsResponse.md + - docs/models/operations/DeleteOrganizationDomainRequest.md + - docs/models/operations/DeleteOrganizationDomainResponse.md + - docs/models/operations/UpdateOrganizationDomainRequestBody.md + - docs/models/operations/UpdateOrganizationDomainRequest.md + - docs/models/operations/UpdateOrganizationDomainResponse.md - docs/models/operations/VerifyDomainProxyRequestBody.md - docs/models/operations/VerifyDomainProxyResponse.md - docs/models/operations/ListRedirectURLsResponse.md @@ -941,11 +1018,14 @@ generatedFiles: - docs/models/operations/DeleteSAMLConnectionRequest.md - docs/models/operations/DeleteSAMLConnectionResponse.md - docs/models/operations/CreateTestingTokenResponse.md + - docs/models/components/Keys.md + - docs/models/components/WellKnownJWKS.md - docs/models/components/Object.md - docs/models/components/Client.md - docs/models/components/SessionObject.md - docs/models/components/Actor.md - docs/models/components/Status.md + - docs/models/components/LatestActivity.md - docs/models/components/Session.md - docs/models/components/Meta.md - docs/models/components/ClerkError.md @@ -996,11 +1076,13 @@ generatedFiles: - docs/models/components/VerificationError.md - docs/models/components/Saml.md - docs/models/components/SAMLAccountVerification.md + - docs/models/components/SAMLConnectionSAMLConnection.md + - docs/models/components/SamlConnection.md - docs/models/components/SAMLAccount.md - docs/models/components/SchemasPasskeyObject.md - docs/models/components/PasskeyVerificationStatus.md - docs/models/components/PasskeyVerificationStrategy.md - - docs/models/components/VerificationNonce.md + - docs/models/components/Nonce.md - docs/models/components/Passkey.md - docs/models/components/SchemasPasskeyVerification.md - docs/models/components/SchemasPasskey.md @@ -1010,7 +1092,6 @@ generatedFiles: - docs/models/components/Web3WalletVerificationAdmin.md - docs/models/components/Web3SignatureVerificationStatus.md - docs/models/components/Web3SignatureVerificationStrategy.md - - docs/models/components/Nonce.md - docs/models/components/Web3Signature.md - docs/models/components/Web3WalletVerification.md - docs/models/components/Web3Wallet.md @@ -1026,6 +1107,12 @@ generatedFiles: - docs/models/components/OrganizationMembershipOrganization.md - docs/models/components/PublicUserData.md - docs/models/components/OrganizationMembership.md + - docs/models/components/OrganizationInvitationsWithPublicOrganizationData.md + - docs/models/components/OrganizationInvitationWithPublicOrganizationDataObject.md + - docs/models/components/OrganizationInvitationWithPublicOrganizationDataPublicMetadata.md + - docs/models/components/OrganizationInvitationWithPublicOrganizationDataPrivateMetadata.md + - docs/models/components/PublicOrganizationData.md + - docs/models/components/OrganizationInvitationWithPublicOrganizationData.md - docs/models/components/InvitationObject.md - docs/models/components/InvitationPublicMetadata.md - docs/models/components/InvitationStatus.md @@ -1034,20 +1121,20 @@ generatedFiles: - docs/models/components/InvitationRevokedPublicMetadata.md - docs/models/components/InvitationRevokedStatus.md - docs/models/components/InvitationRevoked.md + - docs/models/components/OrganizationInvitationObject.md + - docs/models/components/OrganizationInvitationPublicMetadata.md + - docs/models/components/OrganizationInvitationPrivateMetadata.md + - docs/models/components/OrganizationInvitation.md + - docs/models/components/OrganizationInvitations.md - docs/models/components/AllowlistIdentifierObject.md - docs/models/components/IdentifierType.md - docs/models/components/AllowlistIdentifier.md - - docs/models/components/BlocklistIdentifiers.md - docs/models/components/BlocklistIdentifierObject.md - docs/models/components/BlocklistIdentifierIdentifierType.md - docs/models/components/BlocklistIdentifier.md + - docs/models/components/BlocklistIdentifiers.md - docs/models/components/InstanceSettingsObject.md - docs/models/components/InstanceSettings.md - - docs/models/components/InstanceRestrictionsObject.md - - docs/models/components/InstanceRestrictions.md - - docs/models/components/OrganizationSettingsObject.md - - docs/models/components/DomainsEnrollmentModes.md - - docs/models/components/OrganizationSettings.md - docs/models/components/ActorTokenObject.md - docs/models/components/ActorTokenStatus.md - docs/models/components/ActorTokenActor.md @@ -1056,6 +1143,11 @@ generatedFiles: - docs/models/components/DomainObject.md - docs/models/components/Domain.md - docs/models/components/CNameTarget.md + - docs/models/components/InstanceRestrictionsObject.md + - docs/models/components/InstanceRestrictions.md + - docs/models/components/OrganizationSettingsObject.md + - docs/models/components/DomainsEnrollmentModes.md + - docs/models/components/OrganizationSettings.md - docs/models/components/SvixURL.md - docs/models/components/JWTTemplateObject.md - docs/models/components/Claims.md @@ -1069,11 +1161,12 @@ generatedFiles: - docs/models/components/OrganizationWithLogoPublicMetadata.md - docs/models/components/OrganizationWithLogoPrivateMetadata.md - docs/models/components/OrganizationWithLogo.md - - docs/models/components/OrganizationInvitationObject.md - - docs/models/components/OrganizationInvitationPublicMetadata.md - - docs/models/components/OrganizationInvitationPrivateMetadata.md - - docs/models/components/OrganizationInvitation.md - - docs/models/components/OrganizationInvitations.md + - docs/models/components/OrganizationDomainObject.md + - docs/models/components/EnrollmentMode.md + - docs/models/components/OrganizationDomainStatus.md + - docs/models/components/OrganizationDomainVerification.md + - docs/models/components/OrganizationDomain.md + - docs/models/components/OrganizationDomains.md - docs/models/components/ProxyCheckObject.md - docs/models/components/ProxyCheck.md - docs/models/components/RedirectURLObject.md @@ -1094,9 +1187,9 @@ generatedFiles: - docs/models/components/OAuthApplicationWithSecretObject.md - docs/models/components/OAuthApplicationWithSecret.md - docs/models/components/SAMLConnections.md - - docs/models/components/SAMLConnectionObject.md + - docs/models/components/SchemasSAMLConnectionObject.md - docs/models/components/AttributeMapping.md - - docs/models/components/SAMLConnection.md + - docs/models/components/SchemasSAMLConnection.md - docs/models/components/TestingTokenObject.md - docs/models/components/TestingToken.md - docs/models/components/Security.md @@ -1109,21 +1202,28 @@ generatedFiles: - docs/sdks/emailaddresses/README.md - docs/sdks/phonenumbers/README.md - docs/sdks/sessions/README.md + - docs/sdks/emailsmstemplates/README.md + - docs/sdks/emailandsmstemplates/README.md - docs/sdks/templates/README.md - docs/sdks/users/README.md - docs/sdks/invitations/README.md - - docs/sdks/allowlist/README.md - - docs/sdks/blocklist/README.md - - docs/sdks/instance/README.md - - docs/sdks/actors/README.md + - docs/sdks/organizationinvitations/README.md + - docs/sdks/allowlistblocklist/README.md + - docs/sdks/allowlistidentifiers/README.md + - docs/sdks/blocklistidentifiers/README.md + - docs/sdks/betafeatures/README.md + - docs/sdks/actortokens/README.md - docs/sdks/domains/README.md + - docs/sdks/instancesettings/README.md - docs/sdks/webhooks/README.md - docs/sdks/jwttemplates/README.md - docs/sdks/organizations/README.md - - docs/sdks/organizationinvitations/README.md - docs/sdks/organizationmemberships/README.md - - docs/sdks/proxy/README.md + - docs/sdks/organizationdomains/README.md + - docs/sdks/organizationdomain/README.md + - docs/sdks/proxychecks/README.md - docs/sdks/redirecturls/README.md + - docs/sdks/clerkredirecturls/README.md - docs/sdks/signintokens/README.md - docs/sdks/signups/README.md - docs/sdks/oauthapplications/README.md diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index b6e1db8..7d386af 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -12,7 +12,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: true java: - version: 0.3.0-beta.3 + version: 0.3.0-beta.4 additionalDependencies: [] additionalPlugins: [] artifactID: backend-api diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 8099c88..801b34c 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,9 +1,9 @@ -speakeasyVersion: 1.390.1 +speakeasyVersion: 1.385.0 sources: clerk-java-sdk: sourceNamespace: clerk-java-sdk - sourceRevisionDigest: sha256:515e4f10455f21ad59bbe16319a383e9e12c116d55bcf7652c681bba41aa304b - sourceBlobDigest: sha256:9f3e5fb65dd3e8c708debe9a1dc453eeea8f47bd0bce5691c696b39e7b4391db + sourceRevisionDigest: sha256:e0e54d531ac126ba5d82485d6e3b57c849622b9938ef439bfd9a377353f5f0a9 + sourceBlobDigest: sha256:def78a57452610c201cfa2962c4354e41a16ddf30c45520ee396f78452eceb7e tags: - latest - main @@ -11,8 +11,8 @@ targets: clerk-java: source: clerk-java-sdk sourceNamespace: clerk-java-sdk - sourceRevisionDigest: sha256:515e4f10455f21ad59bbe16319a383e9e12c116d55bcf7652c681bba41aa304b - sourceBlobDigest: sha256:9f3e5fb65dd3e8c708debe9a1dc453eeea8f47bd0bce5691c696b39e7b4391db + sourceRevisionDigest: sha256:e0e54d531ac126ba5d82485d6e3b57c849622b9938ef439bfd9a377353f5f0a9 + sourceBlobDigest: sha256:def78a57452610c201cfa2962c4354e41a16ddf30c45520ee396f78452eceb7e outLocation: /github/workspace/repo my-first-target: source: clerk-java-sdk @@ -22,13 +22,14 @@ targets: outLocation: /github/workspace/repo workflow: workflowVersion: 1.0.0 - speakeasyVersion: latest + speakeasyVersion: v1.385.0 sources: clerk-java-sdk: inputs: - - location: ./openapi.yml + - location: https://raw.githubusercontent.com/clerk/openapi-specs/refs/heads/main/bapi/2021-02-05.yml overlays: - location: fixes.yml + - location: .speakeasy/speakeasy-suggestions.yaml registry: location: registry.speakeasyapi.dev/clerk/clerk/clerk-java-sdk targets: diff --git a/README.md b/README.md index 03fcefe..5f079b6 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,6 @@ More information about the API can be found at https://clerk.com/docs * [SDK Installation](#sdk-installation) * [SDK Example Usage](#sdk-example-usage) * [Available Resources and Operations](#available-resources-and-operations) -* [Pagination](#pagination) * [Error Handling](#error-handling) * [Server Selection](#server-selection) * [Authentication](#authentication) @@ -48,7 +47,7 @@ The samples below show how a published SDK artifact is used: Gradle: ```groovy -implementation 'com.clerk:backend-api:0.3.0-beta.3' +implementation 'com.clerk:backend-api:0.3.0-beta.4' ``` Maven: @@ -56,7 +55,7 @@ Maven: com.clerk backend-api - 0.3.0-beta.3 + 0.3.0-beta.4 ``` @@ -78,55 +77,15 @@ gradlew.bat publishToMavenLocal -Pskip.signing ## SDK Example Usage -### Example 1 - -```java -package hello.world; - -import com.clerk.backend_api.Clerk; -import java.lang.Exception; - -public class Application { - - public static void main(String[] args) throws Exception { - try { - Clerk sdk = Clerk.builder() - .bearerAuth("") - .build(); - - sdk.clients().list() - .limit(10L) - .offset(0L) - .callAsStreamUnwrapped() - .forEach(item -> { - // handle item - }); - - } catch (com.clerk.backend_api.models.errors.ClerkErrors e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; - } - - } -} -``` - -### Create Actor Tokens - -This example shows how to create an actor token that can be used to impersonate the given user. +### Example ```java package hello.world; import com.clerk.backend_api.Clerk; import com.clerk.backend_api.models.errors.SDKError; -import com.clerk.backend_api.models.operations.CreateActorTokenRequestBody; -import com.clerk.backend_api.models.operations.CreateActorTokenResponse; +import com.clerk.backend_api.models.operations.GetEmailAddressResponse; import java.lang.Exception; -import java.util.Map; public class Application { @@ -136,17 +95,11 @@ public class Application { .bearerAuth("") .build(); - CreateActorTokenRequestBody req = CreateActorTokenRequestBody.builder() - .userId("") - .actor(Map.ofEntries( - Map.entry("sub", "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"))) - .build(); - - CreateActorTokenResponse res = sdk.actors().createToken() - .request(req) + GetEmailAddressResponse res = sdk.emailAddresses().get() + .emailAddressId("") .call(); - if (res.actorToken().isPresent()) { + if (res.emailAddress().isPresent()) { // handle response } } catch (com.clerk.backend_api.models.errors.ClerkErrors e) { @@ -170,11 +123,11 @@ public class Application { ### [miscellaneous()](docs/sdks/miscellaneous/README.md) -* [getPublicInterstitial](docs/sdks/miscellaneous/README.md#getpublicinterstitial) - Returns the markup for the interstitial page +* [getInterstitial](docs/sdks/miscellaneous/README.md#getinterstitial) - Returns the markup for the interstitial page ### [jwks()](docs/sdks/jwks/README.md) -* [getJWKS](docs/sdks/jwks/README.md#getjwks) - Retrieve the JSON Web Key Set of the instance +* [get](docs/sdks/jwks/README.md#get) - Retrieve the JSON Web Key Set of the instance ### [clients()](docs/sdks/clients/README.md) @@ -204,14 +157,18 @@ public class Application { * [~~verify~~](docs/sdks/sessions/README.md#verify) - Verify a session :warning: **Deprecated** * [createTokenFromTemplate](docs/sdks/sessions/README.md#createtokenfromtemplate) - Create a session token from a jwt template +### [emailSMSTemplates()](docs/sdks/emailsmstemplates/README.md) + +* [~~get~~](docs/sdks/emailsmstemplates/README.md#get) - Retrieve a template :warning: **Deprecated** +* [~~toggleTemplateDelivery~~](docs/sdks/emailsmstemplates/README.md#toggletemplatedelivery) - Toggle the delivery by Clerk for a template of a given type and slug :warning: **Deprecated** + +### [emailAndSmsTemplates()](docs/sdks/emailandsmstemplates/README.md) + +* [~~upsert~~](docs/sdks/emailandsmstemplates/README.md#upsert) - Update a template for a given type and slug :warning: **Deprecated** + ### [templates()](docs/sdks/templates/README.md) -* [list](docs/sdks/templates/README.md#list) - List all templates -* [get](docs/sdks/templates/README.md#get) - Retrieve a template -* [upsert](docs/sdks/templates/README.md#upsert) - Update a template for a given type and slug -* [revert](docs/sdks/templates/README.md#revert) - Revert a template -* [preview](docs/sdks/templates/README.md#preview) - Preview changes to a template -* [toggleDelivery](docs/sdks/templates/README.md#toggledelivery) - Toggle the delivery by Clerk for a template of a given type and slug +* [~~preview~~](docs/sdks/templates/README.md#preview) - Preview changes to a template :warning: **Deprecated** ### [users()](docs/sdks/users/README.md) @@ -230,9 +187,16 @@ public class Application { * [updateMetadata](docs/sdks/users/README.md#updatemetadata) - Merge and update a user's metadata * [getOAuthAccessToken](docs/sdks/users/README.md#getoauthaccesstoken) - Retrieve the OAuth access token of a user * [getOrganizationMemberships](docs/sdks/users/README.md#getorganizationmemberships) - Retrieve all memberships for a user +* [getOrganizationInvitations](docs/sdks/users/README.md#getorganizationinvitations) - Retrieve all invitations for a user * [verifyPassword](docs/sdks/users/README.md#verifypassword) - Verify the password of a user * [verifyTOTP](docs/sdks/users/README.md#verifytotp) - Verify a TOTP or backup code for a user * [disableMFA](docs/sdks/users/README.md#disablemfa) - Disable a user's MFA methods +* [deleteBackupCodes](docs/sdks/users/README.md#deletebackupcodes) - Disable all user's Backup codes +* [deletePasskey](docs/sdks/users/README.md#deletepasskey) - Delete a user passkey +* [deleteWeb3Wallet](docs/sdks/users/README.md#deleteweb3wallet) - Delete a user web3 wallet +* [createTOTP](docs/sdks/users/README.md#createtotp) - Create a TOTP for a user +* [deleteTotp](docs/sdks/users/README.md#deletetotp) - Delete all the user's TOTPs +* [deleteExternalAccount](docs/sdks/users/README.md#deleteexternalaccount) - Delete External Account ### [invitations()](docs/sdks/invitations/README.md) @@ -240,31 +204,41 @@ public class Application { * [list](docs/sdks/invitations/README.md#list) - List all invitations * [revoke](docs/sdks/invitations/README.md#revoke) - Revokes an invitation -### [allowlist()](docs/sdks/allowlist/README.md) +### [organizationInvitations()](docs/sdks/organizationinvitations/README.md) -* [list](docs/sdks/allowlist/README.md#list) - List all identifiers on the allow-list -* [create](docs/sdks/allowlist/README.md#create) - Add identifier to the allow-list -* [delete](docs/sdks/allowlist/README.md#delete) - Delete identifier from allow-list +* [getAll](docs/sdks/organizationinvitations/README.md#getall) - Get a list of organization invitations for the current instance +* [create](docs/sdks/organizationinvitations/README.md#create) - Create and send an organization invitation +* [list](docs/sdks/organizationinvitations/README.md#list) - Get a list of organization invitations +* [bulkCreate](docs/sdks/organizationinvitations/README.md#bulkcreate) - Bulk create and send organization invitations +* [~~listPending~~](docs/sdks/organizationinvitations/README.md#listpending) - Get a list of pending organization invitations :warning: **Deprecated** +* [get](docs/sdks/organizationinvitations/README.md#get) - Retrieve an organization invitation by ID +* [revoke](docs/sdks/organizationinvitations/README.md#revoke) - Revoke a pending organization invitation + +### [allowlistBlocklist()](docs/sdks/allowlistblocklist/README.md) -### [blocklist()](docs/sdks/blocklist/README.md) +* [listAllowlistIdentifiers](docs/sdks/allowlistblocklist/README.md#listallowlistidentifiers) - List all identifiers on the allow-list +* [createAllowlistIdentifier](docs/sdks/allowlistblocklist/README.md#createallowlistidentifier) - Add identifier to the allow-list +* [createBlocklistIdentifier](docs/sdks/allowlistblocklist/README.md#createblocklistidentifier) - Add identifier to the block-list +* [deleteBlocklistIdentifier](docs/sdks/allowlistblocklist/README.md#deleteblocklistidentifier) - Delete identifier from block-list -* [list](docs/sdks/blocklist/README.md#list) - List all identifiers on the block-list -* [create](docs/sdks/blocklist/README.md#create) - Add identifier to the block-list -* [delete](docs/sdks/blocklist/README.md#delete) - Delete identifier from block-list +### [allowlistIdentifiers()](docs/sdks/allowlistidentifiers/README.md) -### [instance()](docs/sdks/instance/README.md) +* [delete](docs/sdks/allowlistidentifiers/README.md#delete) - Delete identifier from allow-list -* [updateAuthConfig](docs/sdks/instance/README.md#updateauthconfig) - Update instance settings -* [~~updateProductionDomain~~](docs/sdks/instance/README.md#updateproductiondomain) - Update production instance domain :warning: **Deprecated** -* [update](docs/sdks/instance/README.md#update) - Update instance settings -* [updateRestrictions](docs/sdks/instance/README.md#updaterestrictions) - Update instance restrictions -* [changeProductionDomain](docs/sdks/instance/README.md#changeproductiondomain) - Update production instance domain -* [updateOrganizationSettings](docs/sdks/instance/README.md#updateorganizationsettings) - Update instance organization settings +### [blocklistIdentifiers()](docs/sdks/blocklistidentifiers/README.md) -### [actors()](docs/sdks/actors/README.md) +* [list](docs/sdks/blocklistidentifiers/README.md#list) - List all identifiers on the block-list -* [createToken](docs/sdks/actors/README.md#createtoken) - Create actor token -* [revokeToken](docs/sdks/actors/README.md#revoketoken) - Revoke actor token +### [betaFeatures()](docs/sdks/betafeatures/README.md) + +* [updateInstanceSettings](docs/sdks/betafeatures/README.md#updateinstancesettings) - Update instance settings +* [~~updateDomain~~](docs/sdks/betafeatures/README.md#updatedomain) - Update production instance domain :warning: **Deprecated** +* [changeProductionInstanceDomain](docs/sdks/betafeatures/README.md#changeproductioninstancedomain) - Update production instance domain + +### [actorTokens()](docs/sdks/actortokens/README.md) + +* [create](docs/sdks/actortokens/README.md#create) - Create actor token +* [revoke](docs/sdks/actortokens/README.md#revoke) - Revoke actor token ### [domains()](docs/sdks/domains/README.md) @@ -273,6 +247,12 @@ public class Application { * [delete](docs/sdks/domains/README.md#delete) - Delete a satellite domain * [update](docs/sdks/domains/README.md#update) - Update a domain +### [instanceSettings()](docs/sdks/instancesettings/README.md) + +* [update](docs/sdks/instancesettings/README.md#update) - Update instance settings +* [updateRestrictions](docs/sdks/instancesettings/README.md#updaterestrictions) - Update instance restrictions +* [updateOrganizationSettings](docs/sdks/instancesettings/README.md#updateorganizationsettings) - Update instance organization settings + ### [webhooks()](docs/sdks/webhooks/README.md) * [createSvixApp](docs/sdks/webhooks/README.md#createsvixapp) - Create a Svix app @@ -298,15 +278,6 @@ public class Application { * [uploadLogo](docs/sdks/organizations/README.md#uploadlogo) - Upload a logo for the organization * [deleteLogo](docs/sdks/organizations/README.md#deletelogo) - Delete the organization's logo. -### [organizationInvitations()](docs/sdks/organizationinvitations/README.md) - -* [create](docs/sdks/organizationinvitations/README.md#create) - Create and send an organization invitation -* [list](docs/sdks/organizationinvitations/README.md#list) - Get a list of organization invitations -* [createBulk](docs/sdks/organizationinvitations/README.md#createbulk) - Bulk create and send organization invitations -* [~~listPending~~](docs/sdks/organizationinvitations/README.md#listpending) - Get a list of pending organization invitations :warning: **Deprecated** -* [get](docs/sdks/organizationinvitations/README.md#get) - Retrieve an organization invitation by ID -* [revoke](docs/sdks/organizationinvitations/README.md#revoke) - Revoke a pending organization invitation - ### [organizationMemberships()](docs/sdks/organizationmemberships/README.md) * [create](docs/sdks/organizationmemberships/README.md#create) - Create a new organization membership @@ -314,17 +285,31 @@ public class Application { * [update](docs/sdks/organizationmemberships/README.md#update) - Update an organization membership * [delete](docs/sdks/organizationmemberships/README.md#delete) - Remove a member from an organization * [updateMetadata](docs/sdks/organizationmemberships/README.md#updatemetadata) - Merge and update organization membership metadata +* [getAll](docs/sdks/organizationmemberships/README.md#getall) - Get a list of all organization memberships within an instance. -### [proxy()](docs/sdks/proxy/README.md) +### [organizationDomains()](docs/sdks/organizationdomains/README.md) -* [verifyDomain](docs/sdks/proxy/README.md#verifydomain) - Verify the proxy configuration for your domain +* [create](docs/sdks/organizationdomains/README.md#create) - Create a new organization domain. +* [list](docs/sdks/organizationdomains/README.md#list) - Get a list of all domains of an organization. +* [delete](docs/sdks/organizationdomains/README.md#delete) - Remove a domain from an organization. + +### [organizationDomain()](docs/sdks/organizationdomain/README.md) + +* [update](docs/sdks/organizationdomain/README.md#update) - Update an organization domain. + +### [proxyChecks()](docs/sdks/proxychecks/README.md) + +* [verify](docs/sdks/proxychecks/README.md#verify) - Verify the proxy configuration for your domain ### [redirectURLs()](docs/sdks/redirecturls/README.md) * [list](docs/sdks/redirecturls/README.md#list) - List all redirect URLs -* [create](docs/sdks/redirecturls/README.md#create) - Create a redirect URL -* [get](docs/sdks/redirecturls/README.md#get) - Retrieve a redirect URL -* [delete](docs/sdks/redirecturls/README.md#delete) - Delete a redirect URL + +### [redirectUrls()](docs/sdks/clerkredirecturls/README.md) + +* [create](docs/sdks/clerkredirecturls/README.md#create) - Create a redirect URL +* [get](docs/sdks/clerkredirecturls/README.md#get) - Retrieve a redirect URL +* [delete](docs/sdks/clerkredirecturls/README.md#delete) - Delete a redirect URL ### [signInTokens()](docs/sdks/signintokens/README.md) @@ -335,12 +320,12 @@ public class Application { * [update](docs/sdks/signups/README.md#update) - Update a sign-up -### [oAuthApplications()](docs/sdks/oauthapplications/README.md) +### [oauthApplications()](docs/sdks/oauthapplications/README.md) * [list](docs/sdks/oauthapplications/README.md#list) - Get a list of OAuth applications for an instance * [create](docs/sdks/oauthapplications/README.md#create) - Create an OAuth application * [get](docs/sdks/oauthapplications/README.md#get) - Retrieve an OAuth application by ID -* [updateApplication](docs/sdks/oauthapplications/README.md#updateapplication) - Update an OAuth application +* [update](docs/sdks/oauthapplications/README.md#update) - Update an OAuth application * [delete](docs/sdks/oauthapplications/README.md#delete) - Delete an OAuth application * [rotateSecret](docs/sdks/oauthapplications/README.md#rotatesecret) - Rotate the client secret of the given OAuth application @@ -357,49 +342,6 @@ public class Application { * [create](docs/sdks/testingtokens/README.md#create) - Retrieve a new testing token - -## Pagination - -Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the -returned response object will have a `next` method that can be called to pull down the next group of results. The `next` -function returns an `Optional` value, which `isPresent` until there are no more pages to be fetched. - -Here's an example of one such pagination call: -```java -package hello.world; - -import com.clerk.backend_api.Clerk; -import java.lang.Exception; - -public class Application { - - public static void main(String[] args) throws Exception { - try { - Clerk sdk = Clerk.builder() - .bearerAuth("") - .build(); - - sdk.clients().list() - .limit(10L) - .offset(0L) - .callAsStreamUnwrapped() - .forEach(item -> { - // handle item - }); - - } catch (com.clerk.backend_api.models.errors.ClerkErrors e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; - } - - } -} -``` - - ## Error Handling @@ -416,6 +358,8 @@ Handling errors in this SDK should largely match your expectations. All operati package hello.world; import com.clerk.backend_api.Clerk; +import com.clerk.backend_api.models.errors.SDKError; +import com.clerk.backend_api.models.operations.GetClientListResponse; import java.lang.Exception; public class Application { @@ -426,17 +370,20 @@ public class Application { .bearerAuth("") .build(); - sdk.clients().list() + GetClientListResponse res = sdk.clients().list() .limit(10L) .offset(0L) - .callAsStreamUnwrapped() - .forEach(item -> { - // handle item - }); + .call(); + if (res.clientList().isPresent()) { + // handle response + } } catch (com.clerk.backend_api.models.errors.ClerkErrors e) { // handle exception throw e; + } catch (SDKError e) { + // handle exception + throw e; } catch (Exception e) { // handle exception throw e; @@ -476,7 +423,7 @@ public class Application { .serverIndex(0) .build(); - GetPublicInterstitialResponse res = sdk.miscellaneous().getPublicInterstitial() + GetPublicInterstitialResponse res = sdk.miscellaneous().getInterstitial() .frontendApi("") .publishableKey("") .call(); @@ -514,7 +461,7 @@ public class Application { .serverURL("https://api.clerk.com/v1") .build(); - GetPublicInterstitialResponse res = sdk.miscellaneous().getPublicInterstitial() + GetPublicInterstitialResponse res = sdk.miscellaneous().getInterstitial() .frontendApi("") .publishableKey("") .call(); @@ -561,7 +508,7 @@ public class Application { .bearerAuth("") .build(); - GetPublicInterstitialResponse res = sdk.miscellaneous().getPublicInterstitial() + GetPublicInterstitialResponse res = sdk.miscellaneous().getInterstitial() .frontendApi("") .publishableKey("") .call(); diff --git a/RELEASES.md b/RELEASES.md index 6086877..9e33606 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -128,4 +128,14 @@ Based on: ### Generated - [java v0.3.0-beta.3] . ### Releases -- [Maven Central v0.3.0-beta.3] https://central.sonatype.com/artifact/com.clerk/backend-api/0.3.0-beta.3 - . \ No newline at end of file +- [Maven Central v0.3.0-beta.3] https://central.sonatype.com/artifact/com.clerk/backend-api/0.3.0-beta.3 - . + +## 2024-10-22 00:08:49 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.385.0 (2.407.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [java v0.3.0-beta.4] . +### Releases +- [Maven Central v0.3.0-beta.4] https://central.sonatype.com/artifact/com.clerk/backend-api/0.3.0-beta.4 - . \ No newline at end of file diff --git a/USAGE.md b/USAGE.md index ac5863c..1f978dd 100644 --- a/USAGE.md +++ b/USAGE.md @@ -2,50 +2,10 @@ ```java package hello.world; -import com.clerk.backend_api.Clerk; -import java.lang.Exception; - -public class Application { - - public static void main(String[] args) throws Exception { - try { - Clerk sdk = Clerk.builder() - .bearerAuth("") - .build(); - - sdk.clients().list() - .limit(10L) - .offset(0L) - .callAsStreamUnwrapped() - .forEach(item -> { - // handle item - }); - - } catch (com.clerk.backend_api.models.errors.ClerkErrors e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; - } - - } -} -``` - -### Create Actor Tokens - -This example shows how to create an actor token that can be used to impersonate the given user. - -```java -package hello.world; - import com.clerk.backend_api.Clerk; import com.clerk.backend_api.models.errors.SDKError; -import com.clerk.backend_api.models.operations.CreateActorTokenRequestBody; -import com.clerk.backend_api.models.operations.CreateActorTokenResponse; +import com.clerk.backend_api.models.operations.GetEmailAddressResponse; import java.lang.Exception; -import java.util.Map; public class Application { @@ -55,17 +15,11 @@ public class Application { .bearerAuth("") .build(); - CreateActorTokenRequestBody req = CreateActorTokenRequestBody.builder() - .userId("") - .actor(Map.ofEntries( - Map.entry("sub", "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"))) - .build(); - - CreateActorTokenResponse res = sdk.actors().createToken() - .request(req) + GetEmailAddressResponse res = sdk.emailAddresses().get() + .emailAddressId("") .call(); - if (res.actorToken().isPresent()) { + if (res.emailAddress().isPresent()) { // handle response } } catch (com.clerk.backend_api.models.errors.ClerkErrors e) { diff --git a/build.gradle b/build.gradle index d719ade..27be926 100644 --- a/build.gradle +++ b/build.gradle @@ -63,7 +63,7 @@ tasks.withType(Javadoc) { } group = "com.clerk" -version = "0.3.0-beta.3" +version = "0.3.0-beta.4" sourcesJar { archiveBaseName = "backend-api" @@ -101,7 +101,7 @@ publishing { maven(MavenPublication) { groupId = 'com.clerk' artifactId = 'backend-api' - version = '0.3.0-beta.3' + version = '0.3.0-beta.4' from components.java @@ -152,7 +152,6 @@ dependencies { implementation 'org.apache.httpcomponents:httpclient:4.5.14' implementation 'org.apache.httpcomponents:httpmime:4.5.14' implementation 'commons-io:commons-io:2.15.1' - implementation 'com.jayway.jsonpath:json-path:2.9.0' } diff --git a/docs/models/components/EnrollmentMode.md b/docs/models/components/EnrollmentMode.md new file mode 100644 index 0000000..6888eb2 --- /dev/null +++ b/docs/models/components/EnrollmentMode.md @@ -0,0 +1,12 @@ +# EnrollmentMode + +Mode of enrollment for the domain + + +## Values + +| Name | Value | +| ---------------------- | ---------------------- | +| `MANUAL_INVITATION` | manual_invitation | +| `AUTOMATIC_INVITATION` | automatic_invitation | +| `AUTOMATIC_SUGGESTION` | automatic_suggestion | \ No newline at end of file diff --git a/docs/models/components/Invitation.md b/docs/models/components/Invitation.md index 031e4ff..ffcf866 100644 --- a/docs/models/components/Invitation.md +++ b/docs/models/components/Invitation.md @@ -12,5 +12,6 @@ | `revoked` | *Optional* | :heavy_minus_sign: | N/A | false | | `status` | [InvitationStatus](../../models/components/InvitationStatus.md) | :heavy_check_mark: | N/A | pending | | `url` | *JsonNullable* | :heavy_minus_sign: | N/A | | +| `expiresAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of expiration.
| | | `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| | | `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| | \ No newline at end of file diff --git a/docs/models/components/InvitationRevoked.md b/docs/models/components/InvitationRevoked.md index 807dc10..6dc8b34 100644 --- a/docs/models/components/InvitationRevoked.md +++ b/docs/models/components/InvitationRevoked.md @@ -12,5 +12,6 @@ | `revoked` | *Optional* | :heavy_minus_sign: | N/A | true | | `status` | [InvitationRevokedStatus](../../models/components/InvitationRevokedStatus.md) | :heavy_check_mark: | N/A | revoked | | `url` | *JsonNullable* | :heavy_minus_sign: | N/A | | +| `expiresAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of expiration.
| | | `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| | | `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| | \ No newline at end of file diff --git a/docs/models/components/InvitationStatus.md b/docs/models/components/InvitationStatus.md index fa867b7..9d487c0 100644 --- a/docs/models/components/InvitationStatus.md +++ b/docs/models/components/InvitationStatus.md @@ -7,4 +7,5 @@ | ---------- | ---------- | | `PENDING` | pending | | `ACCEPTED` | accepted | -| `REVOKED` | revoked | \ No newline at end of file +| `REVOKED` | revoked | +| `EXPIRED` | expired | \ No newline at end of file diff --git a/docs/models/components/Keys.md b/docs/models/components/Keys.md new file mode 100644 index 0000000..e589540 --- /dev/null +++ b/docs/models/components/Keys.md @@ -0,0 +1,13 @@ +# Keys + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `use` | *Optional* | :heavy_minus_sign: | N/A | +| `kty` | *Optional* | :heavy_minus_sign: | N/A | +| `kid` | *Optional* | :heavy_minus_sign: | N/A | +| `alg` | *Optional* | :heavy_minus_sign: | N/A | +| `n` | *Optional* | :heavy_minus_sign: | N/A | +| `e` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/LatestActivity.md b/docs/models/components/LatestActivity.md new file mode 100644 index 0000000..e24c1e7 --- /dev/null +++ b/docs/models/components/LatestActivity.md @@ -0,0 +1,16 @@ +# LatestActivity + + +## Fields + +| Field | Type | Required | Description | +| ------------------- | ------------------- | ------------------- | ------------------- | +| `object` | *String* | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `deviceType` | *Optional* | :heavy_minus_sign: | N/A | +| `isMobile` | *Optional* | :heavy_minus_sign: | N/A | +| `browserName` | *Optional* | :heavy_minus_sign: | N/A | +| `browserVersion` | *Optional* | :heavy_minus_sign: | N/A | +| `ipAddress` | *Optional* | :heavy_minus_sign: | N/A | +| `city` | *Optional* | :heavy_minus_sign: | N/A | +| `country` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/OrganizationDomain.md b/docs/models/components/OrganizationDomain.md new file mode 100644 index 0000000..526c04d --- /dev/null +++ b/docs/models/components/OrganizationDomain.md @@ -0,0 +1,20 @@ +# OrganizationDomain + +An organization domain + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `id` | *Optional* | :heavy_minus_sign: | Unique identifier for the organization domain | +| `object` | [Optional](../../models/components/OrganizationDomainObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value. Always `organization_domain`
| +| `organizationId` | *Optional* | :heavy_minus_sign: | Unique identifier for the organization | +| `name` | *Optional* | :heavy_minus_sign: | Name of the organization domain | +| `enrollmentMode` | [Optional](../../models/components/EnrollmentMode.md) | :heavy_minus_sign: | Mode of enrollment for the domain | +| `affiliationEmailAddress` | *JsonNullable* | :heavy_minus_sign: | Affiliation email address for the domain, if available. | +| `verification` | [JsonNullable](../../models/components/OrganizationDomainVerification.md) | :heavy_minus_sign: | Verification details for the domain | +| `totalPendingInvitations` | *Optional* | :heavy_minus_sign: | Total number of pending invitations associated with this domain | +| `totalPendingSuggestions` | *Optional* | :heavy_minus_sign: | Total number of pending suggestions associated with this domain | +| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp when the domain was created | +| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of the last update to the domain | \ No newline at end of file diff --git a/docs/models/components/OrganizationDomainObject.md b/docs/models/components/OrganizationDomainObject.md new file mode 100644 index 0000000..60cf426 --- /dev/null +++ b/docs/models/components/OrganizationDomainObject.md @@ -0,0 +1,11 @@ +# OrganizationDomainObject + +String representing the object's type. Objects of the same type share the same value. Always `organization_domain` + + + +## Values + +| Name | Value | +| --------------------- | --------------------- | +| `ORGANIZATION_DOMAIN` | organization_domain | \ No newline at end of file diff --git a/docs/models/components/OrganizationDomainStatus.md b/docs/models/components/OrganizationDomainStatus.md new file mode 100644 index 0000000..1b2a5f0 --- /dev/null +++ b/docs/models/components/OrganizationDomainStatus.md @@ -0,0 +1,11 @@ +# OrganizationDomainStatus + +Status of the verification. It can be `unverified` or `verified` + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `UNVERIFIED` | unverified | +| `VERIFIED` | verified | \ No newline at end of file diff --git a/docs/models/components/OrganizationDomainVerification.md b/docs/models/components/OrganizationDomainVerification.md new file mode 100644 index 0000000..12b32d1 --- /dev/null +++ b/docs/models/components/OrganizationDomainVerification.md @@ -0,0 +1,13 @@ +# OrganizationDomainVerification + +Verification details for the domain + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `status` | [Optional](../../models/components/OrganizationDomainStatus.md) | :heavy_minus_sign: | Status of the verification. It can be `unverified` or `verified` | +| `strategy` | *Optional* | :heavy_minus_sign: | Name of the strategy used to verify the domain | +| `attempts` | *Optional* | :heavy_minus_sign: | How many attempts have been made to verify the domain | +| `expireAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of when the verification will expire | \ No newline at end of file diff --git a/docs/models/components/OrganizationDomains.md b/docs/models/components/OrganizationDomains.md new file mode 100644 index 0000000..4d1bbb9 --- /dev/null +++ b/docs/models/components/OrganizationDomains.md @@ -0,0 +1,9 @@ +# OrganizationDomains + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `data` | List<[OrganizationDomain](../../models/components/OrganizationDomain.md)> | :heavy_check_mark: | N/A | +| `totalCount` | *long* | :heavy_check_mark: | Total number of organization domains
| \ No newline at end of file diff --git a/docs/models/components/OrganizationInvitation.md b/docs/models/components/OrganizationInvitation.md index fdcb823..22190ad 100644 --- a/docs/models/components/OrganizationInvitation.md +++ b/docs/models/components/OrganizationInvitation.md @@ -11,6 +11,7 @@ An organization invitation | `object` | [Optional](../../models/components/OrganizationInvitationObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| | `emailAddress` | *Optional* | :heavy_minus_sign: | N/A | | `role` | *Optional* | :heavy_minus_sign: | N/A | +| `roleName` | *Optional* | :heavy_minus_sign: | N/A | | `organizationId` | *Optional* | :heavy_minus_sign: | N/A | | `status` | *Optional* | :heavy_minus_sign: | N/A | | `publicMetadata` | [Optional](../../models/components/OrganizationInvitationPublicMetadata.md) | :heavy_minus_sign: | N/A | diff --git a/docs/models/components/OrganizationInvitationWithPublicOrganizationData.md b/docs/models/components/OrganizationInvitationWithPublicOrganizationData.md new file mode 100644 index 0000000..b44e80d --- /dev/null +++ b/docs/models/components/OrganizationInvitationWithPublicOrganizationData.md @@ -0,0 +1,21 @@ +# OrganizationInvitationWithPublicOrganizationData + +An organization invitation with public organization data populated + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `object` | [Optional](../../models/components/OrganizationInvitationWithPublicOrganizationDataObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| +| `emailAddress` | *Optional* | :heavy_minus_sign: | N/A | +| `role` | *Optional* | :heavy_minus_sign: | N/A | +| `roleName` | *Optional* | :heavy_minus_sign: | N/A | +| `organizationId` | *Optional* | :heavy_minus_sign: | N/A | +| `status` | *Optional* | :heavy_minus_sign: | N/A | +| `publicMetadata` | [Optional](../../models/components/OrganizationInvitationWithPublicOrganizationDataPublicMetadata.md) | :heavy_minus_sign: | N/A | +| `privateMetadata` | [Optional](../../models/components/OrganizationInvitationWithPublicOrganizationDataPrivateMetadata.md) | :heavy_minus_sign: | N/A | +| `publicOrganizationData` | [Optional](../../models/components/PublicOrganizationData.md) | :heavy_minus_sign: | N/A | +| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation. | +| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update. | \ No newline at end of file diff --git a/docs/models/components/OrganizationInvitationWithPublicOrganizationDataObject.md b/docs/models/components/OrganizationInvitationWithPublicOrganizationDataObject.md new file mode 100644 index 0000000..f801fbd --- /dev/null +++ b/docs/models/components/OrganizationInvitationWithPublicOrganizationDataObject.md @@ -0,0 +1,11 @@ +# OrganizationInvitationWithPublicOrganizationDataObject + +String representing the object's type. Objects of the same type share the same value. + + + +## Values + +| Name | Value | +| ------------------------- | ------------------------- | +| `ORGANIZATION_INVITATION` | organization_invitation | \ No newline at end of file diff --git a/docs/models/components/OrganizationInvitationWithPublicOrganizationDataPrivateMetadata.md b/docs/models/components/OrganizationInvitationWithPublicOrganizationDataPrivateMetadata.md new file mode 100644 index 0000000..3b53742 --- /dev/null +++ b/docs/models/components/OrganizationInvitationWithPublicOrganizationDataPrivateMetadata.md @@ -0,0 +1,7 @@ +# OrganizationInvitationWithPublicOrganizationDataPrivateMetadata + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/components/OrganizationInvitationWithPublicOrganizationDataPublicMetadata.md b/docs/models/components/OrganizationInvitationWithPublicOrganizationDataPublicMetadata.md new file mode 100644 index 0000000..f2ca2b2 --- /dev/null +++ b/docs/models/components/OrganizationInvitationWithPublicOrganizationDataPublicMetadata.md @@ -0,0 +1,7 @@ +# OrganizationInvitationWithPublicOrganizationDataPublicMetadata + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/components/OrganizationInvitationsWithPublicOrganizationData.md b/docs/models/components/OrganizationInvitationsWithPublicOrganizationData.md new file mode 100644 index 0000000..f2f0b71 --- /dev/null +++ b/docs/models/components/OrganizationInvitationsWithPublicOrganizationData.md @@ -0,0 +1,9 @@ +# OrganizationInvitationsWithPublicOrganizationData + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `data` | List<[OrganizationInvitationWithPublicOrganizationData](../../models/components/OrganizationInvitationWithPublicOrganizationData.md)> | :heavy_check_mark: | N/A | +| `totalCount` | *long* | :heavy_check_mark: | Total number of organization invitations
| \ No newline at end of file diff --git a/docs/models/components/OrganizationMembership.md b/docs/models/components/OrganizationMembership.md index d4178da..a63be5d 100644 --- a/docs/models/components/OrganizationMembership.md +++ b/docs/models/components/OrganizationMembership.md @@ -10,6 +10,7 @@ Hello world | `id` | *Optional* | :heavy_minus_sign: | N/A | | `object` | [Optional](../../models/components/OrganizationMembershipObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| | `role` | *Optional* | :heavy_minus_sign: | N/A | +| `roleName` | *Optional* | :heavy_minus_sign: | N/A | | `permissions` | List<*String*> | :heavy_minus_sign: | N/A | | `publicMetadata` | [Optional](../../models/components/OrganizationMembershipPublicMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership, accessible from both Frontend and Backend APIs | | `privateMetadata` | [Optional](../../models/components/OrganizationMembershipPrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership, accessible only from the Backend API | diff --git a/docs/models/components/Passkey.md b/docs/models/components/Passkey.md index b733561..943b6d4 100644 --- a/docs/models/components/Passkey.md +++ b/docs/models/components/Passkey.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `status` | [PasskeyVerificationStatus](../../models/components/PasskeyVerificationStatus.md) | :heavy_check_mark: | N/A | | `strategy` | [PasskeyVerificationStrategy](../../models/components/PasskeyVerificationStrategy.md) | :heavy_check_mark: | N/A | -| `nonce` | [Optional](../../models/components/VerificationNonce.md) | :heavy_minus_sign: | N/A | +| `nonce` | [Optional](../../models/components/Nonce.md) | :heavy_minus_sign: | N/A | | `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | | `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/PublicOrganizationData.md b/docs/models/components/PublicOrganizationData.md new file mode 100644 index 0000000..46ca74c --- /dev/null +++ b/docs/models/components/PublicOrganizationData.md @@ -0,0 +1,12 @@ +# PublicOrganizationData + + +## Fields + +| Field | Type | Required | Description | +| ------------------- | ------------------- | ------------------- | ------------------- | +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `name` | *Optional* | :heavy_minus_sign: | N/A | +| `slug` | *Optional* | :heavy_minus_sign: | N/A | +| `imageUrl` | *Optional* | :heavy_minus_sign: | N/A | +| `hasImage` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/SAMLAccount.md b/docs/models/components/SAMLAccount.md index e69579f..e6d0eb2 100644 --- a/docs/models/components/SAMLAccount.md +++ b/docs/models/components/SAMLAccount.md @@ -14,4 +14,5 @@ | `lastName` | *JsonNullable* | :heavy_minus_sign: | N/A | | `providerUserId` | *JsonNullable* | :heavy_minus_sign: | N/A | | `publicMetadata` | [Optional](../../models/components/SAMLAccountPublicMetadata.md) | :heavy_minus_sign: | N/A | -| `verification` | [Optional](../../models/components/SAMLAccountVerification.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `verification` | [Optional](../../models/components/SAMLAccountVerification.md) | :heavy_check_mark: | N/A | +| `samlConnection` | [JsonNullable](../../models/components/SamlConnection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/SAMLConnection.md b/docs/models/components/SAMLConnection.md deleted file mode 100644 index e155a68..0000000 --- a/docs/models/components/SAMLConnection.md +++ /dev/null @@ -1,28 +0,0 @@ -# SAMLConnection - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `object` | [SAMLConnectionObject](../../models/components/SAMLConnectionObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `name` | *String* | :heavy_check_mark: | N/A | -| `domain` | *String* | :heavy_check_mark: | N/A | -| `idpEntityId` | *Optional* | :heavy_check_mark: | N/A | -| `idpSsoUrl` | *Optional* | :heavy_check_mark: | N/A | -| `idpCertificate` | *Optional* | :heavy_check_mark: | N/A | -| `idpMetadataUrl` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `idpMetadata` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `acsUrl` | *String* | :heavy_check_mark: | N/A | -| `spEntityId` | *String* | :heavy_check_mark: | N/A | -| `spMetadataUrl` | *String* | :heavy_check_mark: | N/A | -| `attributeMapping` | [Optional](../../models/components/AttributeMapping.md) | :heavy_minus_sign: | N/A | -| `active` | *boolean* | :heavy_check_mark: | N/A | -| `provider` | *String* | :heavy_check_mark: | N/A | -| `userCount` | *long* | :heavy_check_mark: | N/A | -| `syncUserAttributes` | *boolean* | :heavy_check_mark: | N/A | -| `allowSubdomains` | *Optional* | :heavy_minus_sign: | N/A | -| `allowIdpInitiated` | *Optional* | :heavy_minus_sign: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file diff --git a/docs/models/components/SAMLConnectionSAMLConnection.md b/docs/models/components/SAMLConnectionSAMLConnection.md new file mode 100644 index 0000000..93dc4f1 --- /dev/null +++ b/docs/models/components/SAMLConnectionSAMLConnection.md @@ -0,0 +1,18 @@ +# SAMLConnectionSAMLConnection + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | +| `id` | *String* | :heavy_check_mark: | N/A | +| `name` | *String* | :heavy_check_mark: | N/A | +| `domain` | *String* | :heavy_check_mark: | N/A | +| `active` | *boolean* | :heavy_check_mark: | N/A | +| `provider` | *String* | :heavy_check_mark: | N/A | +| `syncUserAttributes` | *boolean* | :heavy_check_mark: | N/A | +| `allowSubdomains` | *Optional* | :heavy_minus_sign: | N/A | +| `allowIdpInitiated` | *Optional* | :heavy_minus_sign: | N/A | +| `disableAdditionalIdentifications` | *Optional* | :heavy_minus_sign: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file diff --git a/docs/models/components/SAMLConnections.md b/docs/models/components/SAMLConnections.md index 18f5039..5f28a73 100644 --- a/docs/models/components/SAMLConnections.md +++ b/docs/models/components/SAMLConnections.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `data` | List<[SAMLConnection](../../models/components/SAMLConnection.md)> | :heavy_check_mark: | N/A | -| `totalCount` | *long* | :heavy_check_mark: | Total number of SAML Connections
| \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `data` | List<[SchemasSAMLConnection](../../models/components/SchemasSAMLConnection.md)> | :heavy_check_mark: | N/A | +| `totalCount` | *long* | :heavy_check_mark: | Total number of SAML Connections
| \ No newline at end of file diff --git a/docs/models/components/SamlConnection.md b/docs/models/components/SamlConnection.md new file mode 100644 index 0000000..35b8953 --- /dev/null +++ b/docs/models/components/SamlConnection.md @@ -0,0 +1,2 @@ +# SamlConnection + diff --git a/docs/models/components/SchemasSAMLConnection.md b/docs/models/components/SchemasSAMLConnection.md new file mode 100644 index 0000000..cbf9e87 --- /dev/null +++ b/docs/models/components/SchemasSAMLConnection.md @@ -0,0 +1,29 @@ +# SchemasSAMLConnection + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `object` | [SchemasSAMLConnectionObject](../../models/components/SchemasSAMLConnectionObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `name` | *String* | :heavy_check_mark: | N/A | +| `domain` | *String* | :heavy_check_mark: | N/A | +| `idpEntityId` | *Optional* | :heavy_check_mark: | N/A | +| `idpSsoUrl` | *Optional* | :heavy_check_mark: | N/A | +| `idpCertificate` | *Optional* | :heavy_check_mark: | N/A | +| `idpMetadataUrl` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `idpMetadata` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `acsUrl` | *String* | :heavy_check_mark: | N/A | +| `spEntityId` | *String* | :heavy_check_mark: | N/A | +| `spMetadataUrl` | *String* | :heavy_check_mark: | N/A | +| `attributeMapping` | [Optional](../../models/components/AttributeMapping.md) | :heavy_minus_sign: | N/A | +| `active` | *boolean* | :heavy_check_mark: | N/A | +| `provider` | *String* | :heavy_check_mark: | N/A | +| `userCount` | *long* | :heavy_check_mark: | N/A | +| `syncUserAttributes` | *boolean* | :heavy_check_mark: | N/A | +| `allowSubdomains` | *Optional* | :heavy_minus_sign: | N/A | +| `allowIdpInitiated` | *Optional* | :heavy_minus_sign: | N/A | +| `disableAdditionalIdentifications` | *Optional* | :heavy_minus_sign: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file diff --git a/docs/models/components/SAMLConnectionObject.md b/docs/models/components/SchemasSAMLConnectionObject.md similarity index 82% rename from docs/models/components/SAMLConnectionObject.md rename to docs/models/components/SchemasSAMLConnectionObject.md index 152e30a..2fa22f8 100644 --- a/docs/models/components/SAMLConnectionObject.md +++ b/docs/models/components/SchemasSAMLConnectionObject.md @@ -1,4 +1,4 @@ -# SAMLConnectionObject +# SchemasSAMLConnectionObject ## Values diff --git a/docs/models/components/Session.md b/docs/models/components/Session.md index 17e351a..5d604cc 100644 --- a/docs/models/components/Session.md +++ b/docs/models/components/Session.md @@ -13,6 +13,7 @@ | `status` | [Status](../../models/components/Status.md) | :heavy_check_mark: | N/A | | `lastActiveOrganizationId` | *JsonNullable* | :heavy_minus_sign: | N/A | | `lastActiveAt` | *long* | :heavy_check_mark: | N/A | +| `latestActivity` | [JsonNullable](../../models/components/LatestActivity.md) | :heavy_minus_sign: | N/A | | `expireAt` | *long* | :heavy_check_mark: | N/A | | `abandonAt` | *long* | :heavy_check_mark: | N/A | | `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| diff --git a/docs/models/components/Template.md b/docs/models/components/Template.md index 3b9079d..15d1744 100644 --- a/docs/models/components/Template.md +++ b/docs/models/components/Template.md @@ -3,26 +3,27 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | N/A | -| `object` | [Optional](../../models/components/TemplateObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| -| `instanceId` | *JsonNullable* | :heavy_minus_sign: | the id of the instance the template belongs to | -| `resourceType` | *Optional* | :heavy_minus_sign: | whether this is a system (default) or user overridden) template | -| `templateType` | *Optional* | :heavy_minus_sign: | whether this is an email or SMS template | -| `name` | *Optional* | :heavy_minus_sign: | user-friendly name of the template | -| `slug` | *Optional* | :heavy_minus_sign: | machine-friendly name of the template | -| `position` | *Optional* | :heavy_minus_sign: | position with the listing of templates | -| `canRevert` | *Optional* | :heavy_minus_sign: | whether this template can be reverted to the corresponding system default | -| `canDelete` | *Optional* | :heavy_minus_sign: | whether this template can be deleted | -| `canDisable` | *Optional* | :heavy_minus_sign: | whether this template can be disabled, true only for notification SMS templates | -| `subject` | *JsonNullable* | :heavy_minus_sign: | email subject | -| `markup` | *Optional* | :heavy_minus_sign: | the editor markup used to generate the body of the template | -| `body` | *Optional* | :heavy_minus_sign: | the template body before variable interpolation | -| `availableVariables` | List<*String*> | :heavy_minus_sign: | list of variables that are available for use in the template body | -| `requiredVariables` | List<*String*> | :heavy_minus_sign: | list of variables that must be contained in the template body | -| `fromEmailName` | *Optional* | :heavy_minus_sign: | N/A | -| `replyToEmailName` | *Optional* | :heavy_minus_sign: | N/A | -| `deliveredByClerk` | *Optional* | :heavy_minus_sign: | N/A | -| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update.
| -| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation.
| \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `object` | [Optional](../../models/components/TemplateObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| +| `instanceId` | *JsonNullable* | :heavy_minus_sign: | the id of the instance the template belongs to | +| `resourceType` | *Optional* | :heavy_minus_sign: | whether this is a system (default) or user overridden) template | +| `templateType` | *Optional* | :heavy_minus_sign: | whether this is an email or SMS template | +| `name` | *Optional* | :heavy_minus_sign: | user-friendly name of the template | +| `slug` | *Optional* | :heavy_minus_sign: | machine-friendly name of the template | +| `position` | *Optional* | :heavy_minus_sign: | position with the listing of templates | +| `canRevert` | *Optional* | :heavy_minus_sign: | whether this template can be reverted to the corresponding system default | +| `canDelete` | *Optional* | :heavy_minus_sign: | whether this template can be deleted | +| `canToggle` | *Optional* | :heavy_minus_sign: | whether this template can be enabled or disabled, true only for notification SMS templates | +| `subject` | *JsonNullable* | :heavy_minus_sign: | email subject | +| `markup` | *Optional* | :heavy_minus_sign: | the editor markup used to generate the body of the template | +| `body` | *Optional* | :heavy_minus_sign: | the template body before variable interpolation | +| `availableVariables` | List<*String*> | :heavy_minus_sign: | list of variables that are available for use in the template body | +| `requiredVariables` | List<*String*> | :heavy_minus_sign: | list of variables that must be contained in the template body | +| `fromEmailName` | *Optional* | :heavy_minus_sign: | N/A | +| `replyToEmailName` | *Optional* | :heavy_minus_sign: | N/A | +| `deliveredByClerk` | *Optional* | :heavy_minus_sign: | N/A | +| `enabled` | *Optional* | :heavy_minus_sign: | N/A | +| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update.
| +| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation.
| \ No newline at end of file diff --git a/docs/models/components/Type.md b/docs/models/components/Type.md index 74eb9cb..6831d91 100644 --- a/docs/models/components/Type.md +++ b/docs/models/components/Type.md @@ -3,9 +3,10 @@ ## Values -| Name | Value | -| -------------- | -------------- | -| `OAUTH_GOOGLE` | oauth_google | -| `OAUTH_MOCK` | oauth_mock | -| `SAML` | saml | -| `OAUTH_APPLE` | oauth_apple | \ No newline at end of file +| Name | Value | +| --------------- | --------------- | +| `OAUTH_GOOGLE` | oauth_google | +| `OAUTH_MOCK` | oauth_mock | +| `SAML` | saml | +| `OAUTH_APPLE` | oauth_apple | +| `OAUTH_DISCORD` | oauth_discord | \ No newline at end of file diff --git a/docs/models/components/User.md b/docs/models/components/User.md index cc8fbe9..18c3983 100644 --- a/docs/models/components/User.md +++ b/docs/models/components/User.md @@ -41,4 +41,6 @@ | `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation.
| | | `deleteSelfEnabled` | *Optional* | :heavy_minus_sign: | If enabled, user can delete themselves via FAPI.
| | | `createOrganizationEnabled` | *Optional* | :heavy_minus_sign: | If enabled, user can create organizations via FAPI.
| | -| `lastActiveAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of the latest session activity, with day precision.
| 1700690400000 | \ No newline at end of file +| `createOrganizationsLimit` | *JsonNullable* | :heavy_minus_sign: | The maximum number of organizations the user can create. 0 means unlimited.
| | +| `lastActiveAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of the latest session activity, with day precision.
| 1700690400000 | +| `legalAcceptedAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of when the user accepted the legal requirements.
| 1700690400000 | \ No newline at end of file diff --git a/docs/models/components/VerificationNonce.md b/docs/models/components/VerificationNonce.md deleted file mode 100644 index 87cd5b9..0000000 --- a/docs/models/components/VerificationNonce.md +++ /dev/null @@ -1,8 +0,0 @@ -# VerificationNonce - - -## Values - -| Name | Value | -| ------- | ------- | -| `NONCE` | nonce | \ No newline at end of file diff --git a/docs/models/components/Web3Signature.md b/docs/models/components/Web3Signature.md index 487884c..8475086 100644 --- a/docs/models/components/Web3Signature.md +++ b/docs/models/components/Web3Signature.md @@ -7,6 +7,7 @@ | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | `status` | [Web3SignatureVerificationStatus](../../models/components/Web3SignatureVerificationStatus.md) | :heavy_check_mark: | N/A | | `strategy` | [Web3SignatureVerificationStrategy](../../models/components/Web3SignatureVerificationStrategy.md) | :heavy_check_mark: | N/A | -| `nonce` | [Nonce](../../models/components/Nonce.md) | :heavy_check_mark: | N/A | +| `nonce` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `message` | *JsonNullable* | :heavy_minus_sign: | N/A | | `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | | `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/Web3SignatureVerificationStatus.md b/docs/models/components/Web3SignatureVerificationStatus.md index 357fd05..c7e24d3 100644 --- a/docs/models/components/Web3SignatureVerificationStatus.md +++ b/docs/models/components/Web3SignatureVerificationStatus.md @@ -3,6 +3,9 @@ ## Values -| Name | Value | -| ---------- | ---------- | -| `VERIFIED` | verified | \ No newline at end of file +| Name | Value | +| ------------ | ------------ | +| `UNVERIFIED` | unverified | +| `VERIFIED` | verified | +| `FAILED` | failed | +| `EXPIRED` | expired | \ No newline at end of file diff --git a/docs/models/components/Web3SignatureVerificationStrategy.md b/docs/models/components/Web3SignatureVerificationStrategy.md index 0a4e6bd..0a96340 100644 --- a/docs/models/components/Web3SignatureVerificationStrategy.md +++ b/docs/models/components/Web3SignatureVerificationStrategy.md @@ -3,6 +3,7 @@ ## Values -| Name | Value | -| ------------------------- | ------------------------- | -| `WEB3_METAMASK_SIGNATURE` | web3_metamask_signature | \ No newline at end of file +| Name | Value | +| -------------------------------- | -------------------------------- | +| `WEB3_METAMASK_SIGNATURE` | web3_metamask_signature | +| `WEB3_COINBASE_WALLET_SIGNATURE` | web3_coinbase_wallet_signature | \ No newline at end of file diff --git a/docs/models/components/WellKnownJWKS.md b/docs/models/components/WellKnownJWKS.md new file mode 100644 index 0000000..17ee672 --- /dev/null +++ b/docs/models/components/WellKnownJWKS.md @@ -0,0 +1,8 @@ +# WellKnownJWKS + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | +| `keys` | List<[Keys](../../models/components/Keys.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/Actor.md b/docs/models/operations/Actor.md new file mode 100644 index 0000000..95240bb --- /dev/null +++ b/docs/models/operations/Actor.md @@ -0,0 +1,10 @@ +# Actor + +The actor payload. It needs to include a sub property which should contain the ID of the actor. +This whole payload will be also included in the JWT session token. + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/operations/ChangeProductionInstanceDomainRequestBody.md b/docs/models/operations/ChangeProductionInstanceDomainRequestBody.md index af1c182..694e4df 100644 --- a/docs/models/operations/ChangeProductionInstanceDomainRequestBody.md +++ b/docs/models/operations/ChangeProductionInstanceDomainRequestBody.md @@ -3,6 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `homeUrl` | *Optional* | :heavy_minus_sign: | The new home URL of the production instance e.g. https://www.example.com | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `homeUrl` | *Optional* | :heavy_minus_sign: | The new home URL of the production instance e.g. https://www.example.com | +| `isSecondary` | *Optional* | :heavy_minus_sign: | Whether this is a domain for a secondary app, meaning that any subdomain provided is significant and
will be stored as part of the domain. This is useful for supporting multiple apps (one primary and
multiple secondaries) on the same root domain (eTLD+1). | \ No newline at end of file diff --git a/docs/models/operations/CreateActorTokenRequestBody.md b/docs/models/operations/CreateActorTokenRequestBody.md index 62beaac..af2f8b9 100644 --- a/docs/models/operations/CreateActorTokenRequestBody.md +++ b/docs/models/operations/CreateActorTokenRequestBody.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `userId` | *String* | :heavy_check_mark: | The ID of the user that can use the newly created sign in token. | | -| `actor` | Map | :heavy_check_mark: | The actor payload. It needs to include a sub property which should contain the ID of the actor.
This whole payload will be also included in the JWT session token. | {
"sub": "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"
} | +| `userId` | *String* | :heavy_check_mark: | The ID of the user being impersonated. | | +| `actor` | [Actor](../../models/operations/Actor.md) | :heavy_check_mark: | The actor payload. It needs to include a sub property which should contain the ID of the actor.
This whole payload will be also included in the JWT session token. | {
"sub": "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"
} | | `expiresInSeconds` | *Optional* | :heavy_minus_sign: | Optional parameter to specify the life duration of the actor token in seconds.
By default, the duration is 1 hour. | | | `sessionMaxDurationInSeconds` | *Optional* | :heavy_minus_sign: | The maximum duration that the session which will be created by the generated actor token should last.
By default, the duration of a session created via an actor token, lasts 30 minutes. | | \ No newline at end of file diff --git a/docs/models/operations/CreateInvitationRequestBody.md b/docs/models/operations/CreateInvitationRequestBody.md index 216d47a..9e830c4 100644 --- a/docs/models/operations/CreateInvitationRequestBody.md +++ b/docs/models/operations/CreateInvitationRequestBody.md @@ -11,4 +11,5 @@ Required parameters | `publicMetadata` | [Optional](../../models/operations/CreateInvitationPublicMetadata.md) | :heavy_minus_sign: | Metadata that will be attached to the newly created invitation.
The value of this property should be a well-formed JSON object.
Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. | | `redirectUrl` | *Optional* | :heavy_minus_sign: | Optional URL which specifies where to redirect the user once they click the invitation link.
This is only required if you have implemented a [custom flow](https://clerk.com/docs/authentication/invitations#custom-flow) and you're not using Clerk Hosted Pages or Clerk Components. | | `notify_` | *JsonNullable* | :heavy_minus_sign: | Optional flag which denotes whether an email invitation should be sent to the given email address.
Defaults to true. | -| `ignoreExisting` | *JsonNullable* | :heavy_minus_sign: | Whether an invitation should be created if there is already an existing invitation for this email address, or it's claimed by another user. | \ No newline at end of file +| `ignoreExisting` | *JsonNullable* | :heavy_minus_sign: | Whether an invitation should be created if there is already an existing invitation for this email address, or it's claimed by another user. | +| `expiresInDays` | *JsonNullable* | :heavy_minus_sign: | The number of days the invitation will be valid for. By default, the invitation does not expire. | \ No newline at end of file diff --git a/docs/models/operations/RevertTemplateRequest.md b/docs/models/operations/CreateOrganizationDomainRequest.md similarity index 64% rename from docs/models/operations/RevertTemplateRequest.md rename to docs/models/operations/CreateOrganizationDomainRequest.md index fba28e6..7c7901c 100644 --- a/docs/models/operations/RevertTemplateRequest.md +++ b/docs/models/operations/CreateOrganizationDomainRequest.md @@ -1,9 +1,9 @@ -# RevertTemplateRequest +# CreateOrganizationDomainRequest ## Fields | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `templateType` | [RevertTemplatePathParamTemplateType](../../models/operations/RevertTemplatePathParamTemplateType.md) | :heavy_check_mark: | The type of template to revert | -| `slug` | *String* | :heavy_check_mark: | The slug of the template to revert | \ No newline at end of file +| `organizationId` | *String* | :heavy_check_mark: | The ID of the organization where the new domain will be created. | +| `requestBody` | [CreateOrganizationDomainRequestBody](../../models/operations/CreateOrganizationDomainRequestBody.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/CreateOrganizationDomainRequestBody.md b/docs/models/operations/CreateOrganizationDomainRequestBody.md new file mode 100644 index 0000000..c53110c --- /dev/null +++ b/docs/models/operations/CreateOrganizationDomainRequestBody.md @@ -0,0 +1,10 @@ +# CreateOrganizationDomainRequestBody + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| `name` | *Optional* | :heavy_minus_sign: | The name of the new domain | +| `enrollmentMode` | *Optional* | :heavy_minus_sign: | The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion` or `manual_invitation` | +| `verified` | *JsonNullable* | :heavy_minus_sign: | The status of domain's verification. Defaults to true | \ No newline at end of file diff --git a/docs/models/operations/CreateOrganizationDomainResponse.md b/docs/models/operations/CreateOrganizationDomainResponse.md new file mode 100644 index 0000000..c84cff4 --- /dev/null +++ b/docs/models/operations/CreateOrganizationDomainResponse.md @@ -0,0 +1,11 @@ +# CreateOrganizationDomainResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `organizationDomain` | [Optional](../../models/components/OrganizationDomain.md) | :heavy_minus_sign: | An organization domain | \ No newline at end of file diff --git a/docs/models/operations/CreateOrganizationInvitationRequestBody.md b/docs/models/operations/CreateOrganizationInvitationRequestBody.md index f1074ca..2f75890 100644 --- a/docs/models/operations/CreateOrganizationInvitationRequestBody.md +++ b/docs/models/operations/CreateOrganizationInvitationRequestBody.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `emailAddress` | *String* | :heavy_check_mark: | The email address of the new member that is going to be invited to the organization | -| `inviterUserId` | *String* | :heavy_check_mark: | The ID of the user that invites the new member to the organization.
Must be an administrator in the organization. | +| `inviterUserId` | *JsonNullable* | :heavy_minus_sign: | The ID of the user that invites the new member to the organization.
Must be an administrator in the organization. | | `role` | *String* | :heavy_check_mark: | The role of the new member in the organization | | `publicMetadata` | [Optional](../../models/operations/CreateOrganizationInvitationPublicMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. | | `privateMetadata` | [Optional](../../models/operations/CreateOrganizationInvitationPrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. | diff --git a/docs/models/operations/CreateOrganizationRequestBody.md b/docs/models/operations/CreateOrganizationRequestBody.md index 6df38c7..4b79214 100644 --- a/docs/models/operations/CreateOrganizationRequestBody.md +++ b/docs/models/operations/CreateOrganizationRequestBody.md @@ -5,9 +5,10 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *String* | :heavy_check_mark: | The name of the new organization | +| `name` | *String* | :heavy_check_mark: | The name of the new organization.
May not contain URLs or HTML. | | `createdBy` | *String* | :heavy_check_mark: | The ID of the User who will become the administrator for the new organization | | `privateMetadata` | [Optional](../../models/operations/CreateOrganizationPrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization, accessible only from the Backend API | | `publicMetadata` | [Optional](../../models/operations/CreateOrganizationPublicMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API | | `slug` | *Optional* | :heavy_minus_sign: | A slug for the new organization.
Can contain only lowercase alphanumeric characters and the dash "-".
Must be unique for the instance. | -| `maxAllowedMemberships` | *Optional* | :heavy_minus_sign: | The maximum number of memberships allowed for this organization | \ No newline at end of file +| `maxAllowedMemberships` | *Optional* | :heavy_minus_sign: | The maximum number of memberships allowed for this organization | +| `createdAt` | *Optional* | :heavy_minus_sign: | A custom date/time denoting _when_ the organization was created, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | \ No newline at end of file diff --git a/docs/models/operations/CreateSAMLConnectionResponse.md b/docs/models/operations/CreateSAMLConnectionResponse.md index 4df6509..0f03302 100644 --- a/docs/models/operations/CreateSAMLConnectionResponse.md +++ b/docs/models/operations/CreateSAMLConnectionResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `samlConnection` | [Optional](../../models/components/SAMLConnection.md) | :heavy_minus_sign: | A SAML Connection | \ No newline at end of file +| `schemasSAMLConnection` | [Optional](../../models/components/SchemasSAMLConnection.md) | :heavy_minus_sign: | A SAML Connection | \ No newline at end of file diff --git a/docs/models/operations/CreateUserRequestBody.md b/docs/models/operations/CreateUserRequestBody.md index 3a62267..5ff8109 100644 --- a/docs/models/operations/CreateUserRequestBody.md +++ b/docs/models/operations/CreateUserRequestBody.md @@ -3,23 +3,28 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `externalId` | *JsonNullable* | :heavy_minus_sign: | The ID of the user as used in your external systems or your previous authentication solution.
Must be unique across your instance. | -| `firstName` | *JsonNullable* | :heavy_minus_sign: | The first name to assign to the user | -| `lastName` | *JsonNullable* | :heavy_minus_sign: | The last name to assign to the user | -| `emailAddress` | List<*String*> | :heavy_minus_sign: | Email addresses to add to the user.
Must be unique across your instance.
The first email address will be set as the user's primary email address. | -| `phoneNumber` | List<*String*> | :heavy_minus_sign: | Phone numbers to add to the user.
Must be unique across your instance.
The first phone number will be set as the user's primary phone number. | -| `web3Wallet` | List<*String*> | :heavy_minus_sign: | Web3 wallets to add to the user.
Must be unique across your instance.
The first wallet will be set as the user's primary wallet. | -| `username` | *JsonNullable* | :heavy_minus_sign: | The username to give to the user.
It must be unique across your instance. | -| `password` | *JsonNullable* | :heavy_minus_sign: | The plaintext password to give the user.
Must be at least 8 characters long, and can not be in any list of hacked passwords. | -| `passwordDigest` | *Optional* | :heavy_minus_sign: | In case you already have the password digests and not the passwords, you can use them for the newly created user via this property.
The digests should be generated with one of the supported algorithms.
The hashing algorithm can be specified using the `password_hasher` property. | -| `passwordHasher` | [Optional](../../models/operations/PasswordHasher.md) | :heavy_minus_sign: | The hashing algorithm that was used to generate the password digest.
The algorithms we support at the moment are [bcrypt](https://en.wikipedia.org/wiki/Bcrypt), [bcrypt_sha256_django](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/),
[md5](https://en.wikipedia.org/wiki/MD5), pbkdf2_sha256, pbkdf2_sha512, [pbkdf2_sha256_django](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/),
[phpass](https://www.openwall.com/phpass/), [scrypt_firebase](https://firebaseopensource.com/projects/firebase/scrypt/),
[scrypt_werkzeug](https://werkzeug.palletsprojects.com/en/3.0.x/utils/#werkzeug.security.generate_password_hash), [sha256](https://en.wikipedia.org/wiki/SHA-2)
and the [argon2](https://argon2.online/) variants argon2i and argon2id.

If you need support for any particular hashing algorithm, [please let us know](https://clerk.com/support).

Note: for password hashers considered insecure (at this moment MD5 and SHA256), the corresponding user password hashes will be transparently migrated to Bcrypt (a secure hasher) upon the user's first successful password sign in.
Insecure schemes are marked with `(insecure)` in the list below.

Each of the supported hashers expects the incoming digest to be in a particular format. Specifically:

**bcrypt:** The digest should be of the following form:

`$$$`

**bcrypt_sha256_django:** This is the Django-specific variant of Bcrypt, using SHA256 hashing function. The format should be as follows (as exported from Django):

`bcrypt_sha256$$$$`

**md5** (insecure): The digest should follow the regular form e.g.:

`5f4dcc3b5aa765d61d8327deb882cf99`

**pbkdf2_sha256:** This is the PBKDF2 algorithm using the SHA256 hashing function. The format should be as follows:

`pbkdf2_sha256$$$`

Note: Both the salt and the hash are expected to be base64-encoded.

**pbkdf2_sha512:** This is the PBKDF2 algorithm using the SHA512 hashing function. The format should be as follows:

`pbkdf2_sha512$$$`

_iterations:_ The number of iterations used. Must be an integer less than 420000.
_salt:_ The salt used when generating the hash. Must be less than 1024 bytes.
_hash:_ The hex-encoded hash. Must have been generated with a key length less than 1024 bytes.

**pbkdf2_sha256_django:** This is the Django-specific variant of PBKDF2 and the digest should have the following format (as exported from Django):

`pbkdf2_sha256$$$`

Note: The salt is expected to be un-encoded, the hash is expected base64-encoded.

**pbkdf2_sha1:** This is similar to pkbdf2_sha256_django, but with two differences:
1. uses sha1 instead of sha256
2. accepts the hash as a hex-encoded string

The format is the following:

`pbkdf2_sha1$$$`

**phpass:** Portable public domain password hashing framework for use in PHP applications. Digests hashed with phpass have the following sections:

The format is the following:

`$P$`

- $P$ is the prefix used to identify phpass hashes.
- rounds is a single character encoding a 6-bit integer representing the number of rounds used.
- salt is eight characters drawn from [./0-9A-Za-z], providing a 48-bit salt.
- checksum is 22 characters drawn from the same set, encoding the 128-bit checksum with MD5.

**scrypt_firebase:** The Firebase-specific variant of scrypt.
The value is expected to have 6 segments separated by the $ character and include the following information:

_hash:_ The actual Base64 hash. This can be retrieved when exporting the user from Firebase.
_salt:_ The salt used to generate the above hash. Again, this is given when exporting the user.
_signer key:_ The base64 encoded signer key.
_salt separator:_ The base64 encoded salt separator.
_rounds:_ The number of rounds the algorithm needs to run.
_memory cost:_ The cost of the algorithm run

The first 2 (hash and salt) are per user and can be retrieved when exporting the user from Firebase.
The other 4 values (signer key, salt separator, rounds and memory cost) are project-wide settings and can be retrieved from the project's password hash parameters.

Once you have all these, you can combine it in the following format and send this as the digest in order for Clerk to accept it:

`$$$$$`

**scrypt_werkzeug:** The Werkzeug-specific variant of scrypt.

The value is expected to have 3 segments separated by the $ character and include the following information:

_algorithm args:_ The algorithm used to generate the hash.
_salt:_ The salt used to generate the above hash.
_hash:_ The actual Base64 hash.

The algorithm args are the parameters used to generate the hash and are included in the digest.

**argon2i:** Algorithms in the argon2 family generate digests that encode the following information:

_version (v):_ The argon version, version 19 is assumed
_memory (m):_ The memory used by the algorithm (in kibibytes)
_iterations (t):_ The number of iterations to perform
_parallelism (p):_ The number of threads to use

Parts are demarcated by the `$` character, with the first part identifying the algorithm variant.
The middle part is a comma-separated list of the encoding options (memory, iterations, parallelism).
The final part is the actual digest.

`$argon2i$v=19$m=4096,t=3,p=1$4t6CL3P7YiHBtwESXawI8Hm20zJj4cs7/4/G3c187e0$m7RQFczcKr5bIR0IIxbpO2P0tyrLjf3eUW3M3QSwnLc`

**argon2id:** See the previous algorithm for an explanation of the formatting.

For the argon2id case, the value of the algorithm in the first part of the digest is `argon2id`:

`$argon2id$v=19$m=64,t=4,p=8$Z2liZXJyaXNo$iGXEpMBTDYQ8G/71tF0qGjxRHEmR3gpGULcE93zUJVU`

**sha256** (insecure): The digest should be a 64-length hex string, e.g.:

`9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08`

**sha256_salted** (insecure): The digest should be a 64-length hex string with a salt.

The format is the following:
`$`

The value is expected to have 2 segments separated by the $ character and include the following information:
_hash:_ The sha256 hash, a 64-length hex string.
_salt:_ The salt used to generate the above hash. Must be between 1 and 1024 bits. | -| `skipPasswordChecks` | *Optional* | :heavy_minus_sign: | When set to `true` all password checks are skipped.
It is recommended to use this method only when migrating plaintext passwords to Clerk.
Upon migration the user base should be prompted to pick stronger password. | -| `skipPasswordRequirement` | *Optional* | :heavy_minus_sign: | When set to `true`, `password` is not required anymore when creating the user and can be omitted.
This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords.
Please note that you cannot use this flag if password is the only way for a user to sign into your instance. | -| `totpSecret` | *Optional* | :heavy_minus_sign: | In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it.
Please note that currently the supported options are:
* Period: 30 seconds
* Code length: 6 digits
* Algorithm: SHA1 | -| `backupCodes` | List<*String*> | :heavy_minus_sign: | If Backup Codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them.
You must provide the backup codes in plain format or the corresponding bcrypt digest. | -| `publicMetadata` | [Optional](../../models/operations/PublicMetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | -| `privateMetadata` | [Optional](../../models/operations/PrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is only visible to your Backend API | -| `unsafeMetadata` | [Optional](../../models/operations/UnsafeMetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | -| `createdAt` | *Optional* | :heavy_minus_sign: | 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`). | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `externalId` | *JsonNullable* | :heavy_minus_sign: | The ID of the user as used in your external systems or your previous authentication solution.
Must be unique across your instance. | +| `firstName` | *JsonNullable* | :heavy_minus_sign: | The first name to assign to the user | +| `lastName` | *JsonNullable* | :heavy_minus_sign: | The last name to assign to the user | +| `emailAddress` | List<*String*> | :heavy_minus_sign: | Email addresses to add to the user.
Must be unique across your instance.
The first email address will be set as the user's primary email address. | +| `phoneNumber` | List<*String*> | :heavy_minus_sign: | Phone numbers to add to the user.
Must be unique across your instance.
The first phone number will be set as the user's primary phone number. | +| `web3Wallet` | List<*String*> | :heavy_minus_sign: | Web3 wallets to add to the user.
Must be unique across your instance.
The first wallet will be set as the user's primary wallet. | +| `username` | *JsonNullable* | :heavy_minus_sign: | The username to give to the user.
It must be unique across your instance. | +| `password` | *JsonNullable* | :heavy_minus_sign: | The plaintext password to give the user.
Must be at least 8 characters long, and can not be in any list of hacked passwords. | +| `passwordDigest` | *Optional* | :heavy_minus_sign: | In case you already have the password digests and not the passwords, you can use them for the newly created user via this property.
The digests should be generated with one of the supported algorithms.
The hashing algorithm can be specified using the `password_hasher` property. | +| `passwordHasher` | *Optional* | :heavy_minus_sign: | The hashing algorithm that was used to generate the password digest.

The algorithms we support at the moment are [`bcrypt`](https://en.wikipedia.org/wiki/Bcrypt), [`bcrypt_sha256_django`](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/), [`md5`](https://en.wikipedia.org/wiki/MD5), `pbkdf2_sha1`, `pbkdf2_sha256`, [`pbkdf2_sha256_django`](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/),
[`phpass`](https://www.openwall.com/phpass/), [`scrypt_firebase`](https://firebaseopensource.com/projects/firebase/scrypt/),
[`scrypt_werkzeug`](https://werkzeug.palletsprojects.com/en/3.0.x/utils/#werkzeug.security.generate_password_hash), [`sha256`](https://en.wikipedia.org/wiki/SHA-2),
and the [`argon2`](https://argon2.online/) variants: `argon2i` and `argon2id`.

Each of the supported hashers expects the incoming digest to be in a particular format. See the [Clerk docs](https://clerk.com/docs/references/backend/user/create-user) for more information. | +| `skipPasswordChecks` | *Optional* | :heavy_minus_sign: | When set to `true` all password checks are skipped.
It is recommended to use this method only when migrating plaintext passwords to Clerk.
Upon migration the user base should be prompted to pick stronger password. | +| `skipPasswordRequirement` | *Optional* | :heavy_minus_sign: | When set to `true`, `password` is not required anymore when creating the user and can be omitted.
This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords.
Please note that you cannot use this flag if password is the only way for a user to sign into your instance. | +| `totpSecret` | *Optional* | :heavy_minus_sign: | In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it.
Please note that currently the supported options are:
* Period: 30 seconds
* Code length: 6 digits
* Algorithm: SHA1 | +| `backupCodes` | List<*String*> | :heavy_minus_sign: | If Backup Codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them.
You must provide the backup codes in plain format or the corresponding bcrypt digest. | +| `publicMetadata` | [Optional](../../models/operations/PublicMetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | +| `privateMetadata` | [Optional](../../models/operations/PrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is only visible to your Backend API | +| `unsafeMetadata` | [Optional](../../models/operations/UnsafeMetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | +| `deleteSelfEnabled` | *JsonNullable* | :heavy_minus_sign: | If enabled, user can delete themselves via FAPI.
| +| `legalAcceptedAt` | *JsonNullable* | :heavy_minus_sign: | A custom timestamp denoting _when_ the user accepted legal requirements, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | +| `skipLegalChecks` | *JsonNullable* | :heavy_minus_sign: | When set to `true` all legal checks are skipped.
It is not recommended to skip legal checks unless you are migrating a user to Clerk. | +| `createOrganizationEnabled` | *JsonNullable* | :heavy_minus_sign: | If enabled, user can create organizations via FAPI.
| +| `createOrganizationsLimit` | *JsonNullable* | :heavy_minus_sign: | The maximum number of organizations the user can create. 0 means unlimited.
| +| `createdAt` | *Optional* | :heavy_minus_sign: | 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`). | \ No newline at end of file diff --git a/docs/models/operations/CreateUserTOTPRequest.md b/docs/models/operations/CreateUserTOTPRequest.md new file mode 100644 index 0000000..7c2e2d3 --- /dev/null +++ b/docs/models/operations/CreateUserTOTPRequest.md @@ -0,0 +1,8 @@ +# CreateUserTOTPRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | +| `userId` | *String* | :heavy_check_mark: | The ID of the user for whom the TOTP is being created. | \ No newline at end of file diff --git a/docs/models/operations/RevertTemplateResponse.md b/docs/models/operations/CreateUserTOTPResponse.md similarity index 93% rename from docs/models/operations/RevertTemplateResponse.md rename to docs/models/operations/CreateUserTOTPResponse.md index 860186b..cb0c22b 100644 --- a/docs/models/operations/RevertTemplateResponse.md +++ b/docs/models/operations/CreateUserTOTPResponse.md @@ -1,4 +1,4 @@ -# RevertTemplateResponse +# CreateUserTOTPResponse ## Fields @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `template` | [Optional