clerk_backend_api 0.0.12-beta copy "clerk_backend_api: ^0.0.12-beta" to clipboard
clerk_backend_api: ^0.0.12-beta copied to clipboard

Published 2 months ago • verified publisherclerk.com
SDKDartFlutter
PlatformAndroidiOSLinuxmacOSWindows
→

Metadata

The Clerk REST Backend API, meant to be accessed by backend servers.

More...

clerk_backend_api #

The Clerk REST Backend API, meant to be accessed by backend servers.

Versions #

When the API changes in a way that isn't compatible with older versions, a new version is released. Each version is identified by its release date, e.g. 2024-10-01. For more information, please see Clerk API Versions.

Please see https://clerk.com/docs for more information.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 2024-10-01
  • Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://clerk.com/support

Requirements #

Dart 2.12 or later

Installation & Usage #

Github #

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  clerk_backend_api:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local #

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  clerk_backend_api:
    path: /path/to/clerk_backend_api

Tests #

TODO

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:clerk_backend_api/api.dart';

// TODO Configure HTTP Bearer authorization: bearerAuth
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ActorTokensApi();
final createActorTokenRequest = CreateActorTokenRequest(); // CreateActorTokenRequest | 

try {
    final result = api_instance.createActorToken(createActorTokenRequest);
    print(result);
} catch (e) {
    print('Exception when calling ActorTokensApi->createActorToken: $e\n');
}

Documentation for API Endpoints #

All URIs are relative to https://api.clerk.com/v1

Class Method HTTP request Description
ActorTokensApi createActorToken POST /actor_tokens Create actor token
ActorTokensApi revokeActorToken POST /actor_tokens/{actor_token_id}/revoke Revoke actor token
AllowListBlockListApi createAllowlistIdentifier POST /allowlist_identifiers Add identifier to the allow-list
AllowListBlockListApi createBlocklistIdentifier POST /blocklist_identifiers Add identifier to the block-list
AllowListBlockListApi deleteAllowlistIdentifier DELETE /allowlist_identifiers/{identifier_id} Delete identifier from allow-list
AllowListBlockListApi deleteBlocklistIdentifier DELETE /blocklist_identifiers/{identifier_id} Delete identifier from block-list
AllowListBlockListApi listAllowlistIdentifiers GET /allowlist_identifiers List all identifiers on the allow-list
AllowListBlockListApi listBlocklistIdentifiers GET /blocklist_identifiers List all identifiers on the block-list
BetaFeaturesApi changeProductionInstanceDomain POST /instance/change_domain Update production instance domain
BetaFeaturesApi updateInstanceAuthConfig PATCH /beta_features/instance_settings Update instance settings
BetaFeaturesApi updateProductionInstanceDomain PUT /beta_features/domain Update production instance domain
ClientsApi getClient GET /clients/{client_id} Get a client
ClientsApi getClientList GET /clients List all clients
ClientsApi verifyClient POST /clients/verify Verify a client
DomainsApi addDomain POST /domains Add a domain
DomainsApi deleteDomain DELETE /domains/{domain_id} Delete a satellite domain
DomainsApi listDomains GET /domains List all instance domains
DomainsApi updateDomain PATCH /domains/{domain_id} Update a domain
EmailAddressesApi createEmailAddress POST /email_addresses Create an email address
EmailAddressesApi deleteEmailAddress DELETE /email_addresses/{email_address_id} Delete an email address
EmailAddressesApi getEmailAddress GET /email_addresses/{email_address_id} Retrieve an email address
EmailAddressesApi updateEmailAddress PATCH /email_addresses/{email_address_id} Update an email address
EmailSMSTemplatesApi getTemplate GET /templates/{template_type}/{slug} Retrieve a template
EmailSMSTemplatesApi getTemplateList GET /templates/{template_type} List all templates
EmailSMSTemplatesApi previewTemplate POST /templates/{template_type}/{slug}/preview Preview changes to a template
EmailSMSTemplatesApi revertTemplate POST /templates/{template_type}/{slug}/revert Revert a template
EmailSMSTemplatesApi toggleTemplateDelivery POST /templates/{template_type}/{slug}/toggle_delivery Toggle the delivery by Clerk for a template of a given type and slug
EmailSMSTemplatesApi upsertTemplate PUT /templates/{template_type}/{slug} Update a template for a given type and slug
InstanceSettingsApi getInstance GET /instance Fetch the current instance
InstanceSettingsApi updateInstance PATCH /instance Update instance settings
InstanceSettingsApi updateInstanceOrganizationSettings PATCH /instance/organization_settings Update instance organization settings
InstanceSettingsApi updateInstanceRestrictions PATCH /instance/restrictions Update instance restrictions
InvitationsApi createBulkInvitations POST /invitations/bulk Create multiple invitations
InvitationsApi createInvitation POST /invitations Create an invitation
InvitationsApi listInvitations GET /invitations List all invitations
InvitationsApi revokeInvitation POST /invitations/{invitation_id}/revoke Revokes an invitation
JWKSApi getJWKS GET /jwks Retrieve the JSON Web Key Set of the instance
JWTTemplatesApi createJWTTemplate POST /jwt_templates Create a JWT template
JWTTemplatesApi deleteJWTTemplate DELETE /jwt_templates/{template_id} Delete a Template
JWTTemplatesApi getJWTTemplate GET /jwt_templates/{template_id} Retrieve a template
JWTTemplatesApi listJWTTemplates GET /jwt_templates List all templates
JWTTemplatesApi updateJWTTemplate PATCH /jwt_templates/{template_id} Update a JWT template
MiscellaneousApi getPublicInterstitial GET /public/interstitial Returns the markup for the interstitial page
OAuthApplicationsApi createOAuthApplication POST /oauth_applications Create an OAuth application
OAuthApplicationsApi deleteOAuthApplication DELETE /oauth_applications/{oauth_application_id} Delete an OAuth application
OAuthApplicationsApi getOAuthApplication GET /oauth_applications/{oauth_application_id} Retrieve an OAuth application by ID
OAuthApplicationsApi listOAuthApplications GET /oauth_applications Get a list of OAuth applications for an instance
OAuthApplicationsApi rotateOAuthApplicationSecret POST /oauth_applications/{oauth_application_id}/rotate_secret Rotate the client secret of the given OAuth application
OAuthApplicationsApi updateOAuthApplication PATCH /oauth_applications/{oauth_application_id} Update an OAuth application
OrganizationDomainsApi createOrganizationDomain POST /organizations/{organization_id}/domains Create a new organization domain.
OrganizationDomainsApi deleteOrganizationDomain DELETE /organizations/{organization_id}/domains/{domain_id} Remove a domain from an organization.
OrganizationDomainsApi listOrganizationDomains GET /organizations/{organization_id}/domains Get a list of all domains of an organization.
OrganizationDomainsApi updateOrganizationDomain PATCH /organizations/{organization_id}/domains/{domain_id} Update an organization domain.
OrganizationInvitationsApi createOrganizationInvitation POST /organizations/{organization_id}/invitations Create and send an organization invitation
OrganizationInvitationsApi createOrganizationInvitationBulk POST /organizations/{organization_id}/invitations/bulk Bulk create and send organization invitations
OrganizationInvitationsApi getOrganizationInvitation GET /organizations/{organization_id}/invitations/{invitation_id} Retrieve an organization invitation by ID
OrganizationInvitationsApi listInstanceOrganizationInvitations GET /organization_invitations Get a list of organization invitations for the current instance
OrganizationInvitationsApi listOrganizationInvitations GET /organizations/{organization_id}/invitations Get a list of organization invitations
OrganizationInvitationsApi listPendingOrganizationInvitations GET /organizations/{organization_id}/invitations/pending Get a list of pending organization invitations
OrganizationInvitationsApi revokeOrganizationInvitation POST /organizations/{organization_id}/invitations/{invitation_id}/revoke Revoke a pending organization invitation
OrganizationMembershipsApi createOrganizationMembership POST /organizations/{organization_id}/memberships Create a new organization membership
OrganizationMembershipsApi deleteOrganizationMembership DELETE /organizations/{organization_id}/memberships/{user_id} Remove a member from an organization
OrganizationMembershipsApi instanceGetOrganizationMemberships GET /organization_memberships Get a list of all organization memberships within an instance.
OrganizationMembershipsApi listOrganizationMemberships GET /organizations/{organization_id}/memberships Get a list of all members of an organization
OrganizationMembershipsApi updateOrganizationMembership PATCH /organizations/{organization_id}/memberships/{user_id} Update an organization membership
OrganizationMembershipsApi updateOrganizationMembershipMetadata PATCH /organizations/{organization_id}/memberships/{user_id}/metadata Merge and update organization membership metadata
OrganizationsApi createOrganization POST /organizations Create an organization
OrganizationsApi deleteOrganization DELETE /organizations/{organization_id} Delete an organization
OrganizationsApi deleteOrganizationLogo DELETE /organizations/{organization_id}/logo Delete the organization's logo.
OrganizationsApi getOrganization GET /organizations/{organization_id} Retrieve an organization by ID or slug
OrganizationsApi listOrganizations GET /organizations Get a list of organizations for an instance
OrganizationsApi mergeOrganizationMetadata PATCH /organizations/{organization_id}/metadata Merge and update metadata for an organization
OrganizationsApi updateOrganization PATCH /organizations/{organization_id} Update an organization
OrganizationsApi uploadOrganizationLogo PUT /organizations/{organization_id}/logo Upload a logo for the organization
PhoneNumbersApi createPhoneNumber POST /phone_numbers Create a phone number
PhoneNumbersApi deletePhoneNumber DELETE /phone_numbers/{phone_number_id} Delete a phone number
PhoneNumbersApi getPhoneNumber GET /phone_numbers/{phone_number_id} Retrieve a phone number
PhoneNumbersApi updatePhoneNumber PATCH /phone_numbers/{phone_number_id} Update a phone number
ProxyChecksApi verifyDomainProxy POST /proxy_checks Verify the proxy configuration for your domain
RedirectURLsApi createRedirectURL POST /redirect_urls Create a redirect URL
RedirectURLsApi deleteRedirectURL DELETE /redirect_urls/{id} Delete a redirect URL
RedirectURLsApi getRedirectURL GET /redirect_urls/{id} Retrieve a redirect URL
RedirectURLsApi listRedirectURLs GET /redirect_urls List all redirect URLs
SAMLConnectionsApi createSAMLConnection POST /saml_connections Create a SAML Connection
SAMLConnectionsApi deleteSAMLConnection DELETE /saml_connections/{saml_connection_id} Delete a SAML Connection
SAMLConnectionsApi getSAMLConnection GET /saml_connections/{saml_connection_id} Retrieve a SAML Connection by ID
SAMLConnectionsApi listSAMLConnections GET /saml_connections Get a list of SAML Connections for an instance
SAMLConnectionsApi updateSAMLConnection PATCH /saml_connections/{saml_connection_id} Update a SAML Connection
SessionsApi createSession POST /sessions Create a new active session
SessionsApi createSessionToken POST /sessions/{session_id}/tokens Create a session token
SessionsApi createSessionTokenFromTemplate POST /sessions/{session_id}/tokens/{template_name} Create a session token from a jwt template
SessionsApi getSession GET /sessions/{session_id} Retrieve a session
SessionsApi getSessionList GET /sessions List all sessions
SessionsApi revokeSession POST /sessions/{session_id}/revoke Revoke a session
SessionsApi verifySession POST /sessions/{session_id}/verify Verify a session
SignInTokensApi createSignInToken POST /sign_in_tokens Create sign-in token
SignInTokensApi revokeSignInToken POST /sign_in_tokens/{sign_in_token_id}/revoke Revoke the given sign-in token
SignUpsApi getSignUp GET /sign_ups/{id} Retrieve a sign-up by ID
SignUpsApi updateSignUp PATCH /sign_ups/{id} Update a sign-up
TestingTokensApi createTestingToken POST /testing_tokens Retrieve a new testing token
UsersApi banUser POST /users/{user_id}/ban Ban a user
UsersApi createUser POST /users Create a new user
UsersApi deleteBackupCode DELETE /users/{user_id}/backup_code Disable all user's Backup codes
UsersApi deleteExternalAccount DELETE /users/{user_id}/external_accounts/{external_account_id} Delete External Account
UsersApi deleteTOTP DELETE /users/{user_id}/totp Delete all the user's TOTPs
UsersApi deleteUser DELETE /users/{user_id} Delete a user
UsersApi deleteUserProfileImage DELETE /users/{user_id}/profile_image Delete user profile image
UsersApi disableMFA DELETE /users/{user_id}/mfa Disable a user's MFA methods
UsersApi getOAuthAccessToken GET /users/{user_id}/oauth_access_tokens/{provider} Retrieve the OAuth access token of a user
UsersApi getUser GET /users/{user_id} Retrieve a user
UsersApi getUserList GET /users List all users
UsersApi getUsersCount GET /users/count Count users
UsersApi lockUser POST /users/{user_id}/lock Lock a user
UsersApi setUserProfileImage POST /users/{user_id}/profile_image Set user profile image
UsersApi unbanUser POST /users/{user_id}/unban Unban a user
UsersApi unlockUser POST /users/{user_id}/unlock Unlock a user
UsersApi updateUser PATCH /users/{user_id} Update a user
UsersApi updateUserMetadata PATCH /users/{user_id}/metadata Merge and update a user's metadata
UsersApi userPasskeyDelete DELETE /users/{user_id}/passkeys/{passkey_identification_id} Delete a user passkey
UsersApi userWeb3WalletDelete DELETE /users/{user_id}/web3_wallets/{web3_wallet_identification_id} Delete a user web3 wallet
UsersApi usersGetOrganizationInvitations GET /users/{user_id}/organization_invitations Retrieve all invitations for a user
UsersApi usersGetOrganizationMemberships GET /users/{user_id}/organization_memberships Retrieve all memberships for a user
UsersApi verifyPassword POST /users/{user_id}/verify_password Verify the password of a user
UsersApi verifyTOTP POST /users/{user_id}/verify_totp Verify a TOTP or backup code for a user
WaitlistEntriesApi createWaitlistEntry POST /waitlist_entries Create a waitlist entry
WaitlistEntriesApi listWaitlistEntries GET /waitlist_entries List all waitlist entries
WebhooksApi createSvixApp POST /webhooks/svix Create a Svix app
WebhooksApi deleteSvixApp DELETE /webhooks/svix Delete a Svix app
WebhooksApi generateSvixAuthURL POST /webhooks/svix_url Create a Svix Dashboard URL

Documentation For Models #

Documentation For Authorization #

Authentication schemes defined for the API:

bearerAuth #

  • Type: HTTP Bearer authentication

Author #

support@clerk.com

← Metadata

1
likes
130
points
26
downloads

Publisher

verified publisherclerk.com

Weekly Downloads

Metadata

The Clerk REST Backend API, meant to be accessed by backend servers.

Homepage
Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (license)

Dependencies

collection, http, intl, meta

More

Packages that depend on clerk_backend_api

Back