@34fame/rijs 中文文档教程

Question

RapidIdentity JavaScript SDK

开源 SDK 以简化为 RapidIdentity 构建自定义应用程序。

RapidIdentity 是 的身份和访问管理平台身份自动化。

使用此 SDK 可以简化创建自定义集成的过程。 支持云和本地部署。

Getting started

Pre-requisites

您必须通过 https 部署 RapidIdentity 并可供客户端访问。

Installation

此 SDK 可以使用 npm 或 yarn 安装在客户端或服务器 (node.js) 中。

npm install @34fame/ridjs

Node.js

在 Node.js 中导入 SDK。

const rijs = require('@34fame/rijs')

Client Framework

在 vanilla JavaScript 或框架中导入 SDK。

import rijs from '@34fame/rijs'

Usage

Config

每个调用都需要一个配置对象。 这让 SDK 知道在哪里可以找到您的实例。

const config = {
   host: 'acme.rapididentity.com', // Only include host or ip address
   port: 443, // default: 443
   token: '<access_token>', // Provided by `login` endpoint
}

Login

使用登录端点启动用户会话。 它将返回在所有未来调用中都需要的访问令牌。

import rijs from '@34fame/rijs'

const login = async (username, password) => {
   try {
      const token = rijs.login(config, username, password)
      if (!token) return false
      config.token = token
      // other token handler code
      return token
   } catch (err) {
      console.error('login error', err)
      return false
   }
}

Logout

关闭用户会话。

import rijs from '@34fame/rijs'

const logout = async () => {
   try {
      await rijs.logout(config)
      return true
   } catch (err) {
      console.error('logout error', err)
      return false
   }
}

License

检索活动的 RapidIdentity 许可证。

rijs.license(config)

User Profile

检索经过身份验证的用户的配置文件。 这是一个简短的属性列表，用于识别用户

rijs.userProfile(config)

User Data

检索经过身份验证的用户的数据。 这包括来自所有授权委托的所有属性值的集合。 id 值可以从 userProfile() 函数中检索。

rijs.userData(config, id)

User Roles

检索经过身份验证的用户的 RapidIdentity 角色。

rijs.userRoles(config)

User Applications

检索经过身份验证的用户的 RapidIdentity 应用程序对象。

rijs.userApplications(config)

Users

检索对经过身份验证的用户可见的用户列表。

rijs.users(config)

Generic API Call

您可以使用 callApi 调用任何 RapidIdentity API 端点。 这样你就可以 继续使用此 SDK 进行所有操作。 您只需要知道端点 方法、url 和数据要求，其中大部分可以在您的 实例 API 文档 (https://host/api/rest/api-docs)

// Get user applications
rijs.callApi({
   config,
   method: 'get',
   url: '/apps/v2/my/applications',
})

// Create a user (sponsorship)
rijs.callApi({
   config,
   method: 'post',
   url: '/sponsorship/sponsoredAccounts',
   data: {
      givenName: 'Robert',
      surname: 'Johnson',
      email: 'robert1970@yahoo.com',
      sponsorDN: '<sponsorDn>',
   },
})

Licensing

本项目中的代码已获得 MIT 许可。