2.0.3 • Published 8 days ago

c2-sso-client v2.0.3

Weekly downloads
-
License
ISC
Repository
-
Last release
8 days ago

C2SSOClient

系统X、云平台单点登录node客户端。

安装&使用

yarn add c2-sso-client
import initC2Client from 'c2-sso-client';

initC2Client({
    env: {
        // 应用类型:可选值 系统X应用:SYSTEM_X  云平台应用:CLOUD_PLATFORM
        APPLICATION_TYPE,
        // 系统X、云平台认证地址
        AUTH_URL,
        // 系统X、云平台服务地址
        TARGET_URL,
        // 客户端ID
        CLIENT_ID,
        // 客户端秘钥
        CLIENT_SECRET,
        // 云平台apiKey 云平台应用必须配置
        API_KEY,
        // 分类机构ID 系统X应用必须配置
        CATEGORY_ID,
        // 业务模块服务地址
        BUSINESS_TARGET_URL,
        // 系统X、云平台白名单配置
        WHITE_LIST,
        // 业务模块白名单配置
        BUSINESS_WHITE_LIST,
        // node服务API统一前缀
        NODE_API_PREFIX,
        // 系统X、云平台API统一前缀
        API_PREFIX,
        // 业务模块API统一前缀
        BUSINESS_API_PREFIX,
        // node服务启动端口
        NODE_SERVER_PORT,
        // 扩展配置项,可以定义任何类型的值,通过 /common/extensions 接口返回给前端应用
        EXTENSIONS: '',
    },
    staticPath: '/src/web_app',
    isDebug: true,
    isRefreshToken: false,
});

node相关接口说明

公共模块

获取客户端ID

GET /common/client-id

获取扩展配置

GET /common/extensions

用户模块

单点登录

GET /user/sso-login

query参数:

key类型备注
redirectUrlstring登录完成后重定向路径
localUrlstring浏览器地址栏协议+IP+端口

本接口请使用浏览器地址栏访问,需要重定向到系统管理X、云平台完成登录授权。

登出

GET /user/sso-logout

key类型备注
redirectUrlstring退出登录后重定向路径
localUrlstring浏览器地址栏协议+IP+端口

本接口请使用浏览器地址栏访问,需要重定向到系统管理X、云平台完成登出。

自定义登录

POST /user/custom-login

body参数:

key类型备注
accountstring账号
passwordstring密码
typestring固定值:'pwd'
snstring自定义登录页面浏览器地址栏query参数(sn)
redirectUrlstring登录完成后重定向路径

鉴权&获取用户信息

GET /user/authorization

修改密码

POST /user/update-pwd

body参数:

key类型备注
userIdstring用户ID
newPasswordstring新密码
oldPasswordstring原密码
2.0.3

8 days ago

2.0.2

18 days ago

2.0.1

18 days ago

2.0.0

19 days ago

1.2.1

2 months ago

1.2.0

2 months ago

1.1.5

3 months ago

1.1.4

3 months ago

1.1.3

3 months ago

1.1.2

3 months ago

1.1.1

3 months ago

1.1.0

4 months ago

1.0.2

7 months ago

1.0.1

7 months ago

1.0.0

7 months ago

1.0.8

4 months ago

1.0.7

4 months ago

1.0.6

5 months ago

1.0.5

6 months ago

1.0.4

6 months ago

1.0.3

6 months ago

0.0.2

4 years ago

0.0.1

4 years ago