dubhe-sdk-authorization

dubhe-sdk-authorization

dubhe-sdk-authorization - JavaScript client for dubhe authorization service

• Package version: 1.1.99, generate by kosmos-dubhe-sdk-generator@1.2.5
• Build date: 2024-01-02 1657

For more information, please visit http://www.billion-byte.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install dubhe-sdk-authorization --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your dubhe-sdk-authorization from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

Getting Started

Please follow the installation instruction and execute the following JS code:

import { AccessControllerApi } from 'dubhe-sdk-authorization';

const api = new AccessControllerApi(ApiContext.getInstance());
const usercode = "usercode_example"; // {String} 用户名
try {
  const {data} = await api.fetchAccesses(usercode);
} catch(error) {
  console.error(error);
}

API Endpoints

All URIs are relative to http://91.2.3.65:28790/AUTHORIZATION

Class	Method	HTTP request	Description
AccessControllerApi	fetchAccesses	POST /rest/authorization/access/fetchAccesses	获取所有权限
AccessControllerApi	fetchUserResource	POST /rest/authorization/access/fetchUserResource	获取所有权限(按端)
AccessControllerApi	getAccesses	POST /rest/authorization/access/getAccesses	获取自身所有权限
AccessControllerApi	matchAccess	POST /rest/authorization/access/match/{actionCode}/{usercode}	验证权限
AuthControllerApi	login	POST /auth/authorization/login	登录接口
AuthControllerApi	rDPCheck	POST /auth/authorization/rdpCheck	RDP校验接口
AuthControllerApi	totpLogin	POST /auth/authorization/totpLogin	登录接口
CasControllerApi	casLogin	GET /open/authorization/cas/casLogin/{uuid}	casLogin接口
CasPollingControllerApi	casPollingLogin	POST /open/authorization/casPolling/polling/{uuid}	casPollingLogin接口
ChannelControllerApi	fetchAllChannelByApiProductCode	POST /rest/authorization/channel/fetchAllChannelByApiProductCode/{apiProductCode}	验证渠道权限
ChannelControllerApi	fetchAllChannelByUsercode	POST /rest/authorization/channel/fetchAllChannelByUsercode	验证渠道权限
ChannelControllerApi	fetchChannels	POST /rest/authorization/channel/fetchChannels	获取指定用户渠道权限列表信息
ChannelControllerApi	getChannels	POST /rest/authorization/channel/getChannels	获取当前用户渠道权限列表信息
ChannelControllerApi	matchChannel	POST /rest/authorization/channel/match/{apiProductCode}	验证渠道权限
DiscoveryControllerApi	allApplication	GET /rest/authorization/discovery/allApplication	allApplication
DiscoveryControllerApi	discoveryService	GET /rest/authorization/discovery/discoveryService/{serviceName}	discoveryService
MockCacheControllerApi	doMockCache	GET /rest/authorization/mockCache/doMockCache	doMockCache
PingControllerApi	systemPing	GET /open/authorization/ping/ping/ping	systemPing
ProductControllerApi	fetchProducts	POST /rest/authorization/product/fetchProducts	获取指定用户产品树权限列表信息
ProductControllerApi	getProducts	POST /rest/authorization/product/getProducts	获取指定用户产品树权限列表信息
ProductControllerApi	matchProduct	POST /rest/authorization/product/match/{usercode}	验证产品树权限
ProjectControllerApi	fetchDmProjects	POST /rest/authorization/project/fetchDmAllProject	获取指定用户数据管控项目权限列表信息
ProjectControllerApi	fetchProjects	POST /rest/authorization/project/fetchProjects	获取指定用户项目权限列表信息
ProjectControllerApi	getDmProjects	POST /rest/authorization/project/getDmProjects	获取当前用户项目权限列表信息
ProjectControllerApi	getProjects	POST /rest/authorization/project/getProjects	获取当前用户项目权限列表信息
ProjectControllerApi	matchDmProject	POST /rest/authorization/project/matchDmProject/{usercode}	验证项目权限
ProjectControllerApi	matchProject	POST /rest/authorization/project/match/{usercode}	验证项目权限
RdpControllerApi	validateRdp	POST /rest/authorization/rdp/validateRdp	RDP校验接口
RdpControllerApi	validateRdpUserCode	PUT /rest/authorization/rdp/validateRdp	RDP校验接口按用户(端对端)
ReportControllerApi	fetchReports	POST /rest/authorization/report/fetchReports	获取指定用户产品树权限列表信息
ServiceOfflineControllerApi	fireOffline	DELETE /rest/authorization/serviceOffline/fireOffline	fireOffline
Sm2CryptoControllerApi	decryptBySm2	POST /rest/authorization/sm2/crypto/decrypt	在线解密
Sm2CryptoControllerApi	encryptBySm2	POST /rest/authorization/sm2/crypto/encrypt	在线加密
Sm2CryptoControllerApi	getSm2CryptoPublicKey	GET /rest/authorization/sm2/crypto/getPublicKey	获取加密公钥
SuControllerApi	apiKeyLogin	POST /rest/authorization/su/apiKeyLogin	apiKeyLogin接口
SuControllerApi	matchApiKeyRemoteIp	POST /rest/authorization/su/matchApiKeyRemoteIp	matchApiKeyRemoteIp接口
SuControllerApi	sudoLogin	POST /rest/authorization/su/sudoLogin	sudoLogin接口
SuControllerApi	wxLogin	POST /rest/authorization/su/wxLogin	wxLogin接口
SuControllerApi	wxLoginByIdNo	POST /rest/authorization/su/wxLoginByIdNo	idNo接口
SystemCacheControllerApi	systemCacheClearAll	POST /rest/authorization/systemCache/clearAll	清理L2CACHE全部缓存
SystemCacheControllerApi	systemCacheClearMulti	POST /rest/authorization/systemCache/clearMulti	清理L2CACHE缓存
SystemCacheControllerApi	systemCacheList	GET /rest/authorization/systemCache/list	list
TokenControllerApi	refreshTokenUsingPOST	POST /rest/authorization/token/refresh	换取TOKEN接口
TotpControllerApi	getQrOrNullSave	POST /rest/authorization/totp/getQrOrNullSave/{userCode}	获取,若空则生成totpQR
TotpControllerApi	getTotpQr	POST /rest/authorization/totp/getQr	获取totpQR
TotpControllerApi	replace	POST /rest/authorization/totp/replaceByUserCode/{userCode}	替换新totpQR
TotpControllerApi	replaceQR	POST /rest/authorization/totp/replaceQR	获取新totpQR
TotpControllerApi	replaceSaveByUserCode	POST /rest/authorization/totp/replaceSaveByUserCode/{userCode}	替换验证并保存
TotpControllerApi	validateByUserCode	POST /rest/authorization/totp/validateByUserCode/{userCode}	验证
TotpControllerApi	validateTotp	POST /rest/authorization/totp/validate/{correctCode}	验证
TotpControllerApi	validateTotpAndSave	POST /rest/authorization/totp/validateTotpAndSave	验证并保存
UserAuthControllerApi	currentUserDetail	POST /rest/authorization/userauth/currentUserDetail	currentUserDetail
UserAuthControllerApi	currentUserDetailByApiKey	POST /rest/authorization/userauth/currentUserDetailByApiKey	currentUserDetailByApiKey
UserAuthControllerApi	currentUserDetailByIdNo	POST /rest/authorization/userauth/currentUserDetailByIdNo	currentUserDetailByIdNo
UserAuthControllerApi	currentUserDetailByIdNoAllStatus	POST /rest/authorization/userauth/currentUserDetailByIdNoAllStatus	currentUserDetailByIdNoAllStatus
UserAuthControllerApi	currentUserDetailByOpenId	POST /rest/authorization/userauth/currentUserDetailByOpenId	currentUserDetailByOpenId
UserAuthControllerApi	currentUserDetailByTotp	POST /rest/authorization/userauth/currentUserDetailByTotp	currentUserDetailByTotp
UserControllerApi	current	POST /rest/authorization/user/current	获取当前用户信息
UserControllerApi	detail	POST /rest/authorization/user/detail	获取当前用户详细信息

Models

• AuthResponse
• CacheStatsWraper
• GrantedAuthority
• IUser
• SysGroupResource
• TotpQrBean
• ViewUser