IBM SSO Self-Service Provisioner
Project description
ibm-sso
When using SSO Self-Service Provisioner
for single sign-on, ibm-sso
can make your work easier.
Currently only supports fastapi applications.
Getting Started
pip install ibm-sso
Usage
-
Add
ibm-sso
torequirements.txt
ibm-sso==0.1.2
For versions above
0.1.0
,code
andstate
are returned after successful authentication. You need to use thecode
andstate
to obtain token information.For versions lower than
0.1.0
, thetoken
is returned directly after successful authentication. Since thetoken
is returned as thequery param
of the callback, there are security risks. Versions higher than0.1.0
are recommended. -
Install
ibm-sso
fromrequirements.txt
filepipenv install -r requirements.txt
-
Set environment variables
Refer to the .env.template in the sample directory.
-
Import
ibm-sso
in startup fileRefer to the app.py in the sample directory.
-
Protect your API
If your API requires authentication to access, you can refer to sample.py
Sample
There is a full sample in the sample
directory that can be run directly. You can start from the sample to learn how to use ibm-sso.
Deploy project(memo for developer)
-
Deploy project
# https://test.pypi.org/ expect interactive_deploy_test.expect # https://pypi.org/ # expect interactive_deploy.expect
-
Use
test.pypi.org
pipenv install -i https://test.pypi.org/simple/ ibm-sso
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[0.0.1] - 2023-11-28
- First commit
[0.0.2] - 2023-12-06
- Add avatar to UserInfoVO
[0.0.3] - 2023-12-06
Added
- Add avatar to UserInfoVO when the user authenticates.
[0.0.4] - 2024-02-21
Fixed
- Fixed mismatching_state and invalid_grant error.
[0.0.5] - 2024-07-22
Fixed
- Fixed pydantic.errors.PydanticUserError: Cannot create a Pydantic dataclass from UserInfoVO as it is already a Pydantic model.
[0.1.0] - 2024-08-06
Updated
- Replace token with code and state
- Add
/token
and/introspect
api.
[0.1.1] - 2024-08-08
Updated
- Modify the environment from
W3ID_ENDPOINT_DISCOVERY
toW3ID_SERVER_METADATA_URL
[0.1.2] - 2024-10-09
Fixed
- Fixed ModuleNotFoundError: No module named 'util'.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.