解决 Keycloak 电子邮件验证邮件发送问题

使用 API 手动发送 Keycloak 电子邮件验证请求

使用 Node.js 后端脚本与 Keycloak API 交互

// Import required modules
const axios = require('axios');
// Replace with your Keycloak server details
const baseURL = 'https://your-keycloak-server/auth';
const realm = 'your-realm';
const userId = 'user-id';
const adminToken = 'admin-token';
// Define actions for email verification
const actions = ['VERIFY_EMAIL'];
// Function to trigger the email verification
async function sendVerificationEmail() {
  try {
    const response = await axios.post(
      `${baseURL}/admin/realms/${realm}/users/${userId}/execute-actions-email`,
      actions,
      {
        headers: {
          'Authorization': \`Bearer ${adminToken}\`,
          'Content-Type': 'application/json'
        }
      }
    );
    console.log('Email sent successfully:', response.data);
  } catch (error) {
    console.error('Error sending email:', error.response?.data || error.message);
  }
}
// Call the function
sendVerificationEmail();

Keycloak API 通过 Python 手动触发电子邮件

使用 Python 和“requests”库进行 API 交互

import requests
# Replace with your Keycloak server details
base_url = 'https://your-keycloak-server/auth'
realm = 'your-realm'
user_id = 'user-id'
admin_token = 'admin-token'
# Define actions for email verification
actions = ['VERIFY_EMAIL']
# Function to send the verification email
def send_verification_email():
    url = f"{base_url}/admin/realms/{realm}/users/{user_id}/execute-actions-email"
    headers = {
        'Authorization': f'Bearer {admin_token}',
        'Content-Type': 'application/json'
    }
    try:
        response = requests.post(url, json=actions, headers=headers)
        response.raise_for_status()
        print('Email sent successfully:', response.json())
    except requests.exceptions.RequestException as e:
        print('Error sending email:', e)
# Call the function
send_verification_email()

Python 脚本的单元测试

测试 Python 脚本的功能

import unittest
from unittest.mock import patch
# Import your send_verification_email function here
class TestEmailVerification(unittest.TestCase):
    @patch('requests.post')
    def test_send_email_success(self, mock_post):
        mock_post.return_value.status_code = 200
        mock_post.return_value.json.return_value = {'message': 'success'}
        response = send_verification_email()
        self.assertIsNone(response)
if __name__ == '__main__':
    unittest.main()

关于 Keycloak 电子邮件验证的常见问题

1. 目的是什么 execute-actions-email 终点？
2. 该端点用于触发用户的特定操作，例如发送电子邮件验证，无需管理员手动干预。
3. 为什么我得到一个 400 error 当指定体内的动作时？
4. 最有可能的是，您的请求正文格式不正确。确保您使用的数组具有以下操作 ["VERIFY_EMAIL"] 在有效负载中。
5. 如何防止触发所有必需的操作？
6. 始终包含特定的 actions 请求正文中的参数。将其留空将默认执行用户所需的所有操作。
7. Authorization 标头在这些请求中的作用是什么？
8. 这 Authorization 标头通过传递有效的管理令牌来验证您的 API 请求，确保安全通信。
9. 我可以在不影响实际用户的情况下测试 API 吗？
10. 是的！使用模拟工具或单元测试框架来模拟 API 响应并验证脚本，而无需更改生产数据。

完善用户验证流程

使用 Keycloak 的 API 时，仔细注意请求格式可以解决触发不需要的操作等问题。包括特定参数、强大的错误处理和安全令牌可确保可靠且高效的 API 调用。这些实践改进了对用户工作流程的控制。 💡

通过设计模块化和可测试的脚本，开发人员可以调整解决方案以适应不同的场景。这种方法不仅确保了功能，还确保了可扩展性和易于维护性，使开发人员能够自信地应对当前和未来的挑战。 🚀