With this SDK, Python developers can easily interact with the Auth API, enabling hassle-free implementation of user registration, login, and client credential management features within their applications.
Project description
authservice
This API provides token-based authentication for user registration, login, and client credential management. It ensures secure communication by utilizing tokens for authentication. Users can register with unique usernames and passwords, authenticate using client credentials, retrieve client IDs and secrets, and regenerate client credentials as needed. The API supports various user roles, including 'user', 'admin', 'moderator', 'guest', and 'superadmin'.
This package is published in PyPI:
https://pypi.org/project/authservice/
Requirements.
Python 3.7+
Installation & Usage
pip install
If your package is hosted in PyPI:
pip install authservice
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/CodeCrew24/authservice_python
(you may need to run pip
with root permission: sudo pip install git+https://github.com/CodeCrew24/authservice_python
)
Then import the package:
import authservice
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 authservice
Tests
Execute pytest
to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import authservice
from authservice.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://auth-service-latest.onrender.com/auth
# See configuration.py for a list of all supported configuration parameters.
configuration = authservice.Configuration(
host = "https://auth-service-latest.onrender.com/auth"
)
# Enter a context with an instance of the API client
with authservice.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = authservice.DefaultApi(api_client)
username = 'johndoe' # str | User's username
password = 'password123' # str | User's password
try:
# Get client ID and secret
api_response = api_instance.client_get(username, password)
print("The response of DefaultApi->client_get:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->client_get: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://auth-service-latest.onrender.com/auth
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | client_get | GET /client | Get client ID and secret |
DefaultApi | login_client_post | POST /login/client | Logs in a user using client ID and secret |
DefaultApi | regenerate_client_credentials_post | POST /regenerate-client-credentials | Regenerate client credentials |
DefaultApi | register_post | POST /register | Registers a new user |
Documentation For Models
- ClientGet200Response
- ClientGet401Response
- LoginClientPost200Response
- LoginClientPost401Response
- RegenerateClientCredentialsPost200Response
- RegisterPost201Response
- RegisterPost400Response
- RegisterPost500Response
Documentation For Authorization
Endpoints do not require authorization.
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for authservice-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b6e1a9857f198b61e7ac5ce47bc738d85b3b7ad79f56d941d0d6ee009eba598 |
|
MD5 | 96337c8a2fd1bbf8a65e219a9d8b735c |
|
BLAKE2b-256 | cd7aed32dcac163747c8b05c6d7ce44d0f0d36dc18f9be991b6393ecca8944c5 |