用于导出目录的PythonAPI客户端。
directory-sso-api-client的Python项目详细描述
目录sso api client
安装
$ pip install directory-sso-api-client
API客户端需要以下设置:
Setting | Notes |
---|---|
DIRECTORY_SSO_API_CLIENT_BASE_URL | |
DIRECTORY_SSO_API_CLIENT_API_KEY | Unique to client. Retrieved during the on-boarding process. |
DIRECTORY_SSO_API_CLIENT_SENDER_ID | Unique to client. Retrieved during the on-boarding process. |
DIRECTORY_SSO_API_CLIENT_DEFAULT_TIMEOUT |
完成后,可以使用api客户端:
fromdirectory_sso_api_client.clientimportsso_api_client
身份验证后端
将以下内容添加到您的设置中
AUTHENTICATION_BACKENDS = ['directory_sso_api_client.backends.RemoveSSOBackend']
AUTH_USER_MODEL='directory_sso_api_client.SSOUser',
MIDDLEWARE_CLASSES = [
...
'django.contrib.sessions.middleware.SessionMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
...
这将导致用户通过其sso会话cookie进行身份验证,然后附加到request.user
。
开发
$ git clone https://github.com/uktrade/directory-sso-api-client $ cd directory-sso-api-client $ [create virtual environment and activate] $ pip install -r requirements_test.txt
发布到pypi
包应该在合并到主服务器时发布到pypi。如果您需要在本地执行此操作,请从rattic获取凭据并将环境变量添加到主机:
Setting |
---|
DIRECTORY_PYPI_USERNAME |
DIRECTORY_PYPI_PASSWORD |
然后运行以下命令:
make publish