better-auth

API Reference for your Better Auth Instance

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

• API version: 1.1.0
• Package version: 0.0.1-beta13
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install better-auth

(you may need to run pip with root permission: sudo pip install git+https://github.com/chasenlab/better-auth-python.git)

Then import the package:

import better_auth

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import better_auth

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import better_auth
from better_auth.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000/api/auth
# See configuration.py for a list of all supported configuration parameters.
configuration = better_auth.Configuration(
    host = "http://localhost:3000/api/auth" # Replace with your API server host
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = better_auth.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with better_auth.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = better_auth.AdminApi(api_client)
    admin_ban_user_request = better_auth.AdminBanUserRequest() # AdminBanUserRequest | 

    try:
        api_response = api_instance.admin_ban_user(admin_ban_user_request)
        print("The response of AdminApi->admin_ban_user:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdminApi->admin_ban_user: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:3000/api/auth

Documentation For Models

• Account
• AccountInfoGet200Response
• AccountInfoGet200ResponseUser
• AdminBanUserRequest
• AdminCreateUserRequest
• AdminHasPermission200Response
• AdminHasPermissionRequest
• AdminListUserSessions200Response
• AdminListUserSessionsRequest
• AdminListUsers200Response
• AdminRevokeUserSessionRequest
• AdminSetUserPasswordRequest
• AdminSetUserRoleRequest
• AdminUpdateUserRequest
• ApiKeyCreatePost200Response
• ApiKeyCreatePostRequest
• ApiKeyDeletePost200Response
• ApiKeyDeletePostRequest
• ApiKeyGetGet200Response
• ApiKeyListGet200ResponseInner
• ApiKeyUpdatePostRequest
• Apikey
• ChangeEmail200Response
• ChangeEmailRequest
• ChangePassword200Response
• ChangePasswordRequest
• DeleteUser200Response
• DeleteUserCallbackGet200Response
• DeleteUserRequest
• ForgetPassword200Response
• ForgetPasswordRequest
• GeneratePasskeyRegistrationOptions200Response
• GeneratePasskeyRegistrationOptions200ResponseAuthenticatorSelection
• GeneratePasskeyRegistrationOptions200ResponseExcludeCredentialsInner
• GeneratePasskeyRegistrationOptions200ResponsePubKeyCredParamsInner
• GeneratePasskeyRegistrationOptions200ResponseRp
• GeneratePasskeyRegistrationOptions200ResponseUser
• GetSession200Response
• LinkSocialAccount200Response
• LinkSocialAccountRequest
• LinkSocialAccountRequestIdToken
• ListUserAccounts200ResponseInner
• OkGet200Response
• OneTapCallbackPost200Response
• OneTapCallbackPostRequest
• Passkey
• PasskeyDeletePasskeyPost200Response
• PasskeyDeletePasskeyPostRequest
• PasskeyGenerateAuthenticateOptions200Response
• PasskeyUpdatePasskeyPost200Response
• PasskeyUpdatePasskeyPostRequest
• PasskeyVerifyAuthenticationRequest
• PasskeyVerifyRegistrationRequest
• RefreshTokenPost200Response
• RefreshTokenPostRequest
• ResetPassword200Response
• ResetPasswordCallback200Response
• ResetPasswordRequest
• RevokeOtherSessionsPost200Response
• RevokeSessionPost200Response
• RevokeSessionPostRequest
• RevokeSessionsPost200Response
• SendVerificationEmail200Response
• SendVerificationEmail400Response
• SendVerificationEmailRequest
• Session
• SignInEmail200Response
• SignInEmailRequest
• SignOut200Response
• SignUpWithEmailAndPassword200Response
• SignUpWithEmailAndPassword200ResponseUser
• SignUpWithEmailAndPasswordRequest
• SocialSignIn200Response
• SocialSignIn400Response
• SocialSignIn403Response
• SocialSignInRequest
• SocialSignInRequestIdToken
• TwoFactor
• TwoFactorEnablePost200Response
• TwoFactorEnablePostRequest
• TwoFactorGenerateBackupCodesPost200Response
• TwoFactorGenerateBackupCodesPostRequest
• TwoFactorGetTotpUriPost200Response
• TwoFactorGetTotpUriPostRequest
• TwoFactorVerifyBackupCodePost200Response
• TwoFactorVerifyBackupCodePost200ResponseSession
• TwoFactorVerifyBackupCodePost200ResponseUser
• TwoFactorVerifyBackupCodePostRequest
• TwoFactorVerifyOtpPost200Response
• TwoFactorVerifyOtpPost200ResponseUser
• TwoFactorVerifyOtpPostRequest
• TwoFactorVerifyTotpPostRequest
• UnlinkAccountPostRequest
• UpdateUser200Response
• UpdateUserRequest
• User
• Verification
• VerifyEmailGet200Response

Documentation For Authorization

Authentication schemes defined for the API:

apiKeyCookie

• Type: API key
• API key parameter name: apiKeyCookie
• Location:

bearerAuth

• Type: Bearer authentication

Author

chasenspace@gmail.com