Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

activate

  • activate(id: ID): number
  • 根据用户ID 激活用户

    在开启安全配置情况下, 需要 '管理用户&权限' 权限才能访问

    example
    import * as user from 'user'
    
    let res=user.activate(id)
    
    

    Parameters

    • id: ID

      user id

    Returns number

create

  • 创建一个全局的平台用户

    在开启安全配置情况下, 需要 '管理用户&权限' 权限才能访问

    使用独立的事务,不与调用脚本共用一个事务,执行成功后即持久化到数据库中

    example
    import * as user from 'user'
    
    let res=user.create(userInfo)
    
    

    Parameters

    Returns string

createInnerUser

  • createInnerUser(userInfo: UserInfo): string
  • 创建一个平台用户,只存在于当前租户,不能通过账号密码登录

    在开启安全配置情况下, 需要 '管理用户&权限' 权限才能访问

    使用独立的事务,不与调用脚本共用一个事务,执行成功后即持久化到数据库中

    example
    import * as user from 'user'
    
    let res=user.createInnerUser(userInfo)
    
    

    Parameters

    Returns string

deactivate

  • deactivate(id: ID): number
  • 根据ID 冻结用户

    在开启安全配置情况下, 需要 '管理用户&权限' 权限才能访问

    example
    import * as user from 'user'
    
    let res=user.deactivate(id)
    
    

    Parameters

    • id: ID

      user id

    Returns number

exists

  • exists(username: string): boolean
  • 检查指定的用户名是否存在。

    在开启安全配置情况下, 需要 '查看所有用户' 权限才能访问

    check the username exists in current tenant or not

    example
    import * as user from 'user'
    
    let res=user.exists(username)
    
    

    Parameters

    • username: string

    Returns boolean

get

  • 根据ID获取用户信息

    example
    import * as user from 'user'
    
    let res=user.get(id)
    
    

    Parameters

    • id: ID

      user id

    Returns UserInfo

list

  • 列举所有的用户。

    在开启安全配置情况下, 需要 '查看所有用户' 权限才能访问

    example
    import * as user from 'user'
    
    let res=user.list()
    
    

    Returns UserInfo[]

update

  • 根据用户 ID 修改 用户信息

    在开启安全配置情况下, 需要 '管理用户&权限' 权限才能访问

    example
    import * as user from 'user'
    
    let res=user.update(id,userInfo)
    
    

    Parameters

    Returns number