5 个稳定版本
| 1.0.4 | 2023 年 3 月 23 日 |
|---|---|
| 1.0.2 | 2023 年 3 月 21 日 |
| 1.0.1 | 2023 年 3 月 13 日 |
#115 in 邮件
每月 51 次下载
410KB
6K SLoC
clerk.dev 的 Rust 社区 API 客户端
Clerk REST 后端 API，供后端服务器访问。请参阅 https://clerk.com/docs 获取更多信息。
安装
[dependencies]
clerk-sdk-rust-community = { version = "1.0.4" }
API 端点文档
所有 URI 都是相对于 https://api.clerk.dev/v1
| 类 | 方法 | HTTP 请求 | 描述 |
|---|---|---|---|
| ActorTokensApi | create_actor_token | POST /actor_tokens | 创建 actor 令牌 |
| ActorTokensApi | revoke_actor_token | POST /actor_tokens/{actor_token_id}/revoke | 撤销 actor 令牌 |
| AllowListBlockListApi | create_allowlist_identifier | POST /allowlist_identifiers | 将标识符添加到允许列表 |
| AllowListBlockListApi | create_blocklist_identifier | POST /blocklist_identifiers | 将标识符添加到阻止列表 |
| AllowListBlockListApi | delete_allowlist_identifier | DELETE /allowlist_identifiers/{identifier_id} | 从允许列表中删除标识符 |
| AllowListBlockListApi | delete_blocklist_identifier | DELETE /blocklist_identifiers/{identifier_id} | 从阻止列表中删除标识符 |
| AllowListBlockListApi | list_allowlist_identifiers | GET /allowlist_identifiers | 列出允许列表上的所有标识符 |
| AllowListBlockListApi | list_blocklist_identifiers | GET /blocklist_identifiers | 列出阻止列表上的所有标识符 |
| BetaFeaturesApi | update_instance_auth_config | PATCH /beta_features/instance_settings | 更新实例设置 |
| BetaFeaturesApi | update_production_instance_domain | PUT /beta_features/domain | 更新生产实例域名 |
| ClientsApi | get_client | GET /clients/{client_id} | 获取客户端 |
| ClientsApi | get_client_last_active_session | GET /clients/{client_id}/last_active_session | 获取客户端的最后活跃会话 |
| ClientsApi | get_client_list | GET /clients | 列出所有客户端 |
| ClientsApi | verify_client | POST /clients/verify | 验证客户端 |
| EmailAddressesApi | create_email_address | POST /email_addresses | 创建电子邮件地址 |
| EmailAddressesApi | delete_email_address | DELETE /email_addresses/{email_address_id} | 删除电子邮件地址 |
| EmailAddressesApi | get_email_address | GET /email_addresses/{email_address_id} | 检索电子邮件地址 |
| EmailAddressesApi | update_email_address | PATCH /email_addresses/{email_address_id} | 更新电子邮件地址 |
| EmailSmsTemplatesApi | get_template | GET /templates/{template_type}/{slug} | 检索模板 |
| EmailSmsTemplatesApi | get_template_list | GET /templates/{template_type} | 列出所有模板 |
| EmailSmsTemplatesApi | preview_template | POST /templates/{template_type}/{slug}/preview | 预览模板更改 |
| EmailSmsTemplatesApi | revert_template | POST /templates/{template_type}/{slug}/revert | 撤销模板 |
| EmailSmsTemplatesApi | upsert_template | PUT /templates/{template_type}/{slug} | 更新特定类型和缩略名的模板 |
| EmailsApi | create_email | POST /emails | 创建邮件 |
| InstanceSettingsApi | update_instance | PATCH /instance | 更新实例设置 |
| InstanceSettingsApi | update_instance_organization_settings | PATCH /instance/organization_settings | 更新实例组织设置 |
| InstanceSettingsApi | update_instance_restrictions | PATCH /instance/restrictions | 更新实例限制 |
| InvitationsApi | create_invitation | POST /invitations | 创建邀请 |
| InvitationsApi | list_invitations | GET /invitations | 列出所有邀请 |
| InvitationsApi | revoke_invitation | POST /invitations/{invitation_id}/revoke | 撤销邀请 |
| JwksApi | get_jwks | GET /jwks | 检索实例的JSON Web Key集 |
| JwtTemplatesApi | create_jwt_template | POST /jwt_templates | 创建JWT模板 |
| JwtTemplatesApi | delete_jwt_template | DELETE /jwt_templates/{template_id} | 删除模板 |
| JwtTemplatesApi | get_jwt_template | GET /jwt_templates/{template_id} | 检索模板 |
| JwtTemplatesApi | 列出JWT模板 | GET /jwt_templates | 列出所有模板 |
| JwtTemplatesApi | update_jwt_template | PATCH /jwt_templates/{template_id} | 更新JWT模板 |
| MiscellaneousApi | create_demo_instance | POST /public/demo_instance | 创建演示开发实例 |
| MiscellaneousApi | get_public_interstitial | GET /public/interstitial | 返回中间页面的标记 |
| OrganizationInvitationsApi | create_organization_invitation | POST /organizations/{organization_id}/invitations | 创建并发送组织邀请 |
| OrganizationInvitationsApi | list_pending_organization_invitations | GET /organizations/{organization_id}/invitations/pending | 获取待处理组织邀请列表 |
| OrganizationInvitationsApi | revoke_organization_invitation | POST /organizations/{organization_id}/invitations/{invitation_id}/revoke | 撤销待处理组织邀请 |
| OrganizationMembershipsApi | create_organization_membership | POST /organizations/{organization_id}/memberships | 创建新的组织成员资格 |
| OrganizationMembershipsApi | delete_organization_membership | DELETE /organizations/{organization_id}/memberships/{user_id} | 从组织中删除成员 |
| OrganizationMembershipsApi | list_organization_memberships | GET /organizations/{organization_id}/memberships | 获取组织中所有成员的列表 |
| OrganizationMembershipsApi | update_organization_membership | PATCH /organizations/{organization_id}/memberships/{user_id} | 更新组织成员资格 |
| OrganizationMembershipsApi | update_organization_membership_metadata | PATCH /organizations/{organization_id}/memberships/{user_id}/metadata | 合并并更新组织成员资格元数据 |
| OrganizationsApi | create_organization | POST /organizations | 创建组织 |
| OrganizationsApi | delete_organization | DELETE /organizations/{organization_id} | 删除组织 |
| OrganizationsApi | get_organization | GET /organizations/{organization_id} | 通过ID或缩略名检索组织 |
| OrganizationsApi | list_organizations | GET /organizations | 获取实例的组织列表 |
| OrganizationsApi | merge_organization_metadata | PATCH /organizations/{organization_id}/metadata | 合并并更新组织的元数据 |
| OrganizationsApi | update_organization | PATCH /organizations/{organization_id} | 更新组织 |
| OrganizationsApi | upload_organization_logo | PUT /organizations/{organization_id}/logo | 上传组织的徽标 |
| PhoneNumbersApi | create_phone_number | POST /phone_numbers | 创建电话号码 |
| PhoneNumbersApi | delete_phone_number | DELETE /phone_numbers/{phone_number_id} | 删除电话号码 |
| PhoneNumbersApi | get_phone_number | GET /phone_numbers/{phone_number_id} | 检索电话号码 |
| PhoneNumbersApi | update_phone_number | PATCH /phone_numbers/{phone_number_id} | 更新电话号码 |
| RedirectUrlsApi | create_redirect_url | POST /redirect_urls | |
| RedirectUrlsApi | 删除重定向URL | DELETE /redirect_urls/{id} | 删除一个重定向URL |
| RedirectUrlsApi | 获取重定向URL | GET /redirect_urls/{id} | 检索一个重定向URL |
| RedirectUrlsApi | 列出所有重定向URL | GET /redirect_urls | 列出所有重定向URL |
| SmsMessagesApi | 创建短信消息 | POST /sms_messages | 创建一个短信消息 |
| SessionsApi | 从模板创建会话令牌 | POST /sessions/{session_id}/tokens/{template_name} | 从jwt模板创建会话令牌 |
| SessionsApi | 获取会话 | GET /sessions/{session_id} | 检索会话 |
| SessionsApi | 获取会话列表 | GET /sessions | 列出所有会话 |
| SessionsApi | 撤销会话 | POST /sessions/{session_id}/revoke | 撤销一个会话 |
| SessionsApi | 验证会话 | POST /sessions/{session_id}/verify | 验证一个会话 |
| SignInTokensApi | 创建登录令牌 | POST /sign_in_tokens | 创建登录令牌 |
| SignInTokensApi | 撤销登录令牌 | POST /sign_in_tokens/{sign_in_token_id}/revoke | 撤销指定的登录令牌 |
| SignUpsApi | 更新注册 | PATCH /sign_ups/{id} | 更新一个注册 |
| UsersApi | 禁止用户 | POST /users/{user_id}/ban | 禁止一个用户 |
| UsersApi | 创建用户 | POST /users | 创建新用户 |
| UsersApi | 删除用户 | DELETE /users/{user_id} | 删除一个用户 |
| UsersApi | 禁用多因素认证 | DELETE /users/{user_id}/mfa | 禁用一个用户的MFA方法 |
| UsersApi | 获取OAuth访问令牌 | GET /users/{user_id}/oauth_access_tokens/{provider} | 检索用户的OAuth访问令牌 |
| UsersApi | 获取用户 | GET /users/{user_id} | 检索一个用户 |
| UsersApi | 获取用户列表 | GET /users | 列出所有用户 |
| UsersApi | 计数用户 | GET /users/count | 计数用户 |
| UsersApi | 解禁用户 | POST /users/{user_id}/unban | 解禁一个用户 |
| UsersApi | 更新用户 | PATCH /users/{user_id} | 更新一个用户 |
| UsersApi | 更新用户元数据 | PATCH /users/{user_id}/metadata | 合并并更新用户的元数据 |
| UsersApi | 获取用户的组织成员资格 | GET /users/{user_id}/organization_memberships | 检索一个用户的所有成员资格 |
| UsersApi | 验证密码 | POST /users/{user_id}/verify_password | 验证用户的密码 |
| UsersApi | 验证TOTP | POST /users/{user_id}/verify_totp | 验证用户的TOTP或备用代码 |
| WebhooksApi | 创建Svix应用 | POST /webhooks/svix | 创建Svix应用 |
| WebhooksApi | 删除Svix应用 | DELETE /webhooks/svix | 删除Svix应用 |
| WebhooksApi | 生成Svix授权URL | POST /webhooks/svix_url | 创建Svix仪表板URL |
模型文档
- ActorToken
- 管理员
- 允许列表标识符
- 黑名单标识符
- 黑名单标识符列表
- ClerkError
- ClerkErrors
- 客户端
- 创建ActorToken请求
- 创建DemoInstance200响应
- 创建电子邮件地址请求
- 创建电子邮件请求
- 创建邀请请求
- 创建JWT模板请求
- 创建组织邀请请求
- 创建组织成员资格请求
- 创建组织请求
- 创建电话号码请求
- 创建重定向URL请求
- 从模板创建会话令牌200响应
- 创建登录令牌请求
- 创建短信消息请求
- 创建用户请求
- 已删除对象
- 禁用Mfa200响应
- 电子邮件
- 电子邮件地址
- 电子邮件地址验证
- 获取OAuth访问令牌200响应内部
- 身份链接
- 实例限制
- 邀请
- JWT模板
- 合并组织元数据请求
- 组织
- 组织邀请
- 组织邀请列表
- 组织成员资格
- 组织成员资格组织
- 组织成员资格公共用户数据
- 组织成员资格列表
- 组织设置
- 带Logo的组织
- 带Logo的组织全部
- 组织列表
- OTP
- 电话号码
- 预览模板请求
- 重定向URL
- 撤销组织邀请请求
- 会话
- 登录令牌
- 注册
- 短信消息
- SvixUrl
- 模板
- 总数
- 更新电子邮件地址请求
- 更新实例认证配置200响应
- 更新实例认证配置请求
- 更新实例组织设置请求
- 更新实例请求
- 更新实例限制请求
- 更新组织成员元数据请求
- 更新组织成员请求
- 更新组织请求
- 更新电话号码请求
- 更新生产实例域名请求
- 更新注册请求
- 更新用户元数据请求
- 更新用户请求
- 插入或更新模板请求
- 用户
- 验证客户端请求
- 验证密码200响应
- 验证密码请求
- 验证会话请求
- 验证Totp200响应
- 验证Totp请求
- Web3签名
- Web3钱包
- Web3钱包验证
依赖项
~4–16MB
~247K SLoC