Python SDK built for Casdoor
Project description
casdoor-python-sdk
Casdoor's SDK for Python will allow you to easily connect your application to the Casdoor authentication system without having to implement it from scratch.
Casdoor-python-sdk is available on PyPI:
$ pip install casdoor
Casdoor SDK is simple to use. We will show you the steps below.
Step1. Init Config
Initialization requires 5 parameters, which are all str type:
| Name (in order) | Must | Description |
|---|---|---|
| endpoint | Yes | Casdoor Server Url, such as http://localhost:8000 |
| client_id | Yes | Application.client_id |
| client_secret | Yes | Application.client_secret |
| certificate | Yes | Same as Casdoor certificate |
| org_name | Yes | Organization name |
from casdoor import CasdoorSDK
certificate = b'''-----BEGIN CERTIFICATE-----
MIIE+TCCAuGgAwIBAgIDAeJAMA0GCSqGSIb3DQEBCwUAMDYxHTAbBgNVBAoTFENh
...
-----END CERTIFICATE-----'''
sdk = CasdoorSDK(
endpoint,
client_id,
client_secret,
certificate,
org_name,
)
OR use async version
from casdoor import AsyncCasdoorSDK
certificate = b'''-----BEGIN CERTIFICATE-----
MIIE+TCCAuGgAwIBAgIDAeJAMA0GCSqGSIb3DQEBCwUAMDYxHTAbBgNVBAoTFENh
...
-----END CERTIFICATE-----'''
sdk = AsyncCasdoorSDK(
endpoint,
client_id,
client_secret,
certificate,
org_name,
)
Step2. Authorize with the Casdoor server
At this point, we should use some ways to verify with the Casdoor server.
To start, we want you understand clearly the verification process of Casdoor.
The following paragraphs will mention your app that wants to use Casdoor as a means
of verification as APP, and Casdoor as Casdoor.
-
APPwill send a request toCasdoor.
SinceCasdooris a UI-based OAuth provider, you cannot use request management service like Postman to send a URL with parameters and get back a JSON file. -
The simplest way to try it out is to type the URL in your browser (in which JavaScript can be executed to run the UI).
-
Type in the URL in your browser in this format:
endpoint/login/oauth/authorize?client_id=xxx&response_type=code&redirect_uri=xxx&scope=read&state=xxx
In this URL theendpointis your Casdoor's location, as mentioned in Step1; then thexxxneed to be filled out by yourself.
Hints:
-
redirect_uriis the URL that yourAPPis configured to listen to the response fromCasdoor. For example, if yourredirect_uriishttps://forum.casbin.com/callback, then Casdoor will send a request to this URL along with two parameterscodeandstate, which will be used in later steps for authentication. -
stateis usually your Application's name, you can find it under theApplicationstab inCasdoor, and the leftmostNamecolumn gives each application's name. -
Of course you want your
APPto be able to send the URL. For example you should have something like a button, and it carries this URL. So when you click the button, you should be redirected toCasdoorfor verification. For now you are typing it in the browser simply for testing.
Step3. Get token and parse
After Casdoor verification passed, it will be redirected to your application with code and state as said in Step2, like https://forum.casbin.com/callback?code=xxx&state=yyyy.
Your web application can get the code and call get_oauth_token(code), then parse out jwt token.
The general process is as follows:
access_token = sdk.get_oauth_token(code)
decoded_msg = sdk.parse_jwt_token(access_token)
decoded_msg is the JSON data decoded from the access_token, which contains user info and other useful stuff.
Step4. Interact with the users
casdoor-python-sdk support basic user operations, like:
get_user(user_id: str), get one user by user name.get_users(), get all users.modify_user(method: str, user: User)/add_user(user: User)/update_user(user: User)/delete_user(user: User), write user to database.refresh_token_request(refresh_token: str, scope: str), refresh access token
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
File details
Details for the file casdoor-1.5.0.tar.gz.
File metadata
- Download URL: casdoor-1.5.0.tar.gz
- Upload date:
- Size: 11.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e35cd72dedfd2c74c218dc4d7d2adf434236a34f02cc951da3230395d373d384 |
|
| MD5 | b5f21db1c80dd6a47e3106cd199e2dfe |
|
| BLAKE2b-256 | 4c6541ef1a9ddc6bec3c1773451875a7a05b7851886f1e0c421e99863ed5c8d0 |
File details
Details for the file casdoor-1.5.0-py2.py3-none-any.whl.
File metadata
- Download URL: casdoor-1.5.0-py2.py3-none-any.whl
- Upload date:
- Size: 12.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 55f89cc581411dc32609b9c87efbedbd162aa7071fb264fd62314ca355b05ef8 |
|
| MD5 | a5b4c1fd35c116ae8e94dfe9bc3ce9c2 |
|
| BLAKE2b-256 | b4138d44f85da309b5522fe2db3a762812e5ec80d41a4321f11e0ab0dadabe09 |
