ukgovernmentdfe/login.dfe.directories

login.dfe.directories 镜像说明

镜像概述

login.dfe.directories是英国***教育部（DfE）登录系统的目录微服务，用于管理用户信息并提供认证相关功能，支持文件、MongoDB、Redis和Azure Active Directory（AD）等多种用户数据存储适配器。

核心功能

• 用户信息查询：通过用户名、用户ID获取单个或多个用户详情
• 用户认证：验证用户账号与密码的有效性
• 密码管理：支持用户密码修改操作
• 验证码服务：提供验证码的生成、验证及删除功能
• 多适配器兼容：适配不同类型的用户数据存储方式

使用场景

• 作为DfE登录系统的核心组件，提供用户目录服务
• 为第三方应用提供统一的用户数据访问与认证接口
• 满足不同存储类型（文件、MongoDB、Redis、Azure AD）的用户管理需求

配置说明

适配器配置

根据存储类型选择对应的适配器配置：

1. 文件适配器

json
{
  "adapter": {
    "type": "file"
  }
}

使用app_data目录下的users.json文件存储用户数据。

2. MongoDB适配器

json
{
  "adapter": {
    "type": "mongo",
    "params": {
      "mongoConnection": "mongodb://your-mongo-host:27017"
    }
  }
}

需在MongoDB中创建Users集合，用户文档需包含email字段。

3. Redis适配器

json
{
  "adapter": {
    "type": "redis",
    "params": {
      "redisurl": "redis://your-redis-host:6379"
    }
  }
}

需在Redis中创建Users集合存储用户列表，并以User_[Sub]为键存储单个用户详情。

4. Azure AD适配器

需设置以下环境变量：

• LDAP_URL：Azure AD的LDAPS地址
• LDAP_BASE_DN：Azure AD的基础DN
• LDAP_USERNAME：连接Azure AD的用户名
• LDAP_PASSWORD：连接Azure AD的密码

适配器配置示例：

json
{
  "adapter": {
    "type": "azuread",
    "params": {
      "url": "ldaps://your-azure-ad-url",
      "baseDN": "dc=your-domain,dc=com",
      "username": "admin@your-domain.com",
      "password": "your-password"
    }
  }
}

用户验证码配置

若需使用密码重置等功能，需配置验证码存储：

json
{
  "userCodes": {
    "redisUrl": "redis://your-redis-host:6379",
    "staticCode": false
  }
}

staticCode设为true时，验证码固定为ABC123。

API接口说明

用户相关接口

• 按用户名查询：GET /users/:username
• 按ID查询：GET /users/:uid 或 GET /users/by-id?id=uid1,uid2（支持批量查询）
• 用户认证：POST /users/authenticate
  请求体示例：

  json
  {
    "username": "test@test.com",
    "password": "Password1"
  }
  

• 修改密码：POST /users/:id/changepassword
  请求体示例：

  json
  {
    "password": "new-password"
  }
  

验证码相关接口

• 生成验证码：PUT /upsert
  请求体示例：

  json
  {
    "uid": "user-123",
    "clientId": "app-client"
  }
  

• 验证验证码：GET /validate/:uid/:code（返回true或false）
• 删除验证码：DELETE /:uid