google-identitytoolkit3 库允许访问 Google 身份工具包 服务的所有功能。

本文档是从 身份工具包 crate 版本 5.0.5+20180723 生成的，其中 20180723 是由 mako 代码生成器 v5.0.5 构建的 identitytoolkit:v3 模式的确切修订版。

关于 身份工具包 v3 API 的其他所有信息都可以在 官方文档网站 找到。

功能

轻松从中央 中心 处理以下 资源 ...

• relyingparty
• 创建认证URI，删除账户，下载账户，邮箱链接登录，获取账户信息，获取离线确认码，获取项目配置，获取公钥，获取reCAPTCHA参数，重置密码，发送验证码，设置账户信息，设置项目配置，注销用户，注册新用户，上传账户，验证断言，验证自定义令牌，验证密码以及验证电话号码

库结构

API结构如下主要项目

• 中心
  • 一个中心对象，用于维护状态和允许访问所有活动
  • 创建方法构建器，它反过来允许访问单个调用构建器
• 资源
  • 你可以应用活动的主要类型
  • 一组属性和部分
  • 部分
    • 一组属性
    • 在活动中永远不会直接使用
• 活动
  • 应用于资源的操作

所有结构都带有相应的特质，以进一步分类它们并便于浏览。

一般来说，你可以这样调用活动

let r = hub.resource().activity(...).doit().await

或具体地...

let r = hub.relyingparty().verify_assertion(...).doit().await

resource()和activity(...)调用创建构建器。后者处理活动，支持各种方法来配置即将进行的操作（此处未显示）。它被设计成必须立即指定所有必需的参数（即(...)），而所有可选的参数都可以按需要构建。doit()方法执行与服务器的实际通信并返回相应的结果。

用法

设置你的项目

要使用此库，您需要将以下行放入您的Cargo.toml文件中

[dependencies]
google-identitytoolkit3 = "*"
serde = "^1.0"
serde_json = "^1.0"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_identitytoolkit3 as identitytoolkit3;
use identitytoolkit3::api::IdentitytoolkitRelyingpartyVerifyAssertionRequest;
use identitytoolkit3::{Result, Error};
use std::default::Default;
use identitytoolkit3::{IdentityToolkit, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = IdentityToolkit::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = IdentitytoolkitRelyingpartyVerifyAssertionRequest::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.relyingparty().verify_assertion(req)
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

错误处理

系统产生的所有错误都以 Result 枚举的形式作为 doit() 方法的返回值提供，或者作为可能的中继结果传递给 Hub Delegate，或者 Authenticator Delegate。

当代理处理错误或中间值时，它们有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

如果一个方法支持下载，响应体（它是 Result 的一部分）应该由您读取以获取媒体。如果这样的方法还支持 Response Result，则默认返回该结果。您可以将其视为实际媒体的元数据。要触发媒体下载，您必须通过此调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用最多 2 种不同的协议进行上传：简单 和 可恢复。每种协议的独特性由自定义的 doit(...) 方法表示，分别命名为 upload(...) 和 upload_resumable(...)。

自定义和回调

您可以通过向 Method Builder 提供一个 delegate 来改变 doit() 方法的调用方式，在最终调用 doit() 之前。相应的函数将被调用以提供进度信息，并确定系统在失败时是否应该重试。

delegate trait 具有默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

此库提供的所有结构都旨在通过 json 进行 编码 和 解码。可选部分用于表示部分请求和响应是有效的。大多数可选部分都是可识别的 Parts，可按名称识别，将被发送到服务器以指示请求的设置部分或响应中期望的部分。

构建器参数

通过 method builders，您可以通过重复调用其方法来准备一个动作调用。这些方法始终只接受一个参数，以下语句是真实的。

• PODs 通过复制传递
• 字符串作为 &str 传递
• 请求值已移动

参数总是会复制或克隆到构建器中，以使它们与它们的原始生命周期独立。

Cargo 功能

• utoipa - 添加对 utoipa 的支持，并在所有类型上派生 utoipa::ToSchema。您必须在 #[openapi(schemas(...))] 中导入和注册所需类型，否则生成的 openapi 规范将无效。

许可证

identitytoolkit3 库由 Sebastian Thiel 生成，并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。