google-cloudidentity1 库允许访问 Google Cloud Identity 服务的所有功能。

本文档是从 Cloud Identity 库版本 5.0.5+20240625 生成的，其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 cloudidentity:v1 架构的精确修订。

关于 Cloud Identity v1 API 的其他所有信息都可以在 官方文档站点 找到。

功能

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

• 客户
• 用户邀请取消、获取用户邀请、检查是否可邀请用户、列出用户邀请 和 发送用户邀请
• 设备
• 取消擦除，创建，删除，设备用户批准，设备用户阻止，设备用户取消擦除，设备用户客户端状态获取，设备用户客户端状态列表，设备用户客户端状态修补，设备用户删除，设备用户获取，设备用户列表，设备用户查找，设备用户擦除，获取，列表和擦除
• 组
• 创建，删除，获取，获取安全设置，列表，查找，成员检查传递性成员资格，创建成员资格，删除成员资格，获取成员资格，获取成员资格图，成员资格列表，成员资格查找，修改成员资格角色，成员资格搜索直接组，成员资格搜索传递组，成员资格搜索传递成员资格，修补，搜索和更新安全设置
• 入站SAML SSO配置文件
• 创建，删除，获取，添加IDP凭据，删除IDP凭据，获取IDP凭据，列出IDP凭据，列出和修补
• 内部SSO分配
• 创建，删除，获取，列出和修补

库的结构

API结构如下

• 枢纽
  • 一个中央对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，这些构建器反过来允许访问单个调用构建器
• 资源
  • 你可以应用活动的主要类型
  • 属性和部分的集合
  • 部分
    • 属性集合
    • 不在活动中直接使用
• 活动
  • 应用于资源的操作

所有结构都标有适用的特性，以进一步分类它们并简化浏览。

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

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

或者具体...

let r = hub.customers().userinvitations_cancel(...).doit().await
let r = hub.customers().userinvitations_send(...).doit().await
let r = hub.devices().device_users_client_states_patch(...).doit().await
let r = hub.devices().device_users_approve(...).doit().await
let r = hub.devices().device_users_block(...).doit().await
let r = hub.devices().device_users_cancel_wipe(...).doit().await
let r = hub.devices().device_users_delete(...).doit().await
let r = hub.devices().device_users_wipe(...).doit().await
let r = hub.devices().cancel_wipe(...).doit().await
let r = hub.devices().create(...).doit().await
let r = hub.devices().delete(...).doit().await
let r = hub.devices().wipe(...).doit().await
let r = hub.groups().memberships_create(...).doit().await
let r = hub.groups().memberships_delete(...).doit().await
let r = hub.groups().memberships_get_membership_graph(...).doit().await
let r = hub.groups().create(...).doit().await
let r = hub.groups().delete(...).doit().await
let r = hub.groups().patch(...).doit().await
let r = hub.groups().update_security_settings(...).doit().await
let r = hub.inbound_saml_sso_profiles().idp_credentials_add(...).doit().await
let r = hub.inbound_saml_sso_profiles().idp_credentials_delete(...).doit().await
let r = hub.inbound_saml_sso_profiles().create(...).doit().await
let r = hub.inbound_saml_sso_profiles().delete(...).doit().await
let r = hub.inbound_saml_sso_profiles().patch(...).doit().await
let r = hub.inbound_sso_assignments().create(...).doit().await
let r = hub.inbound_sso_assignments().delete(...).doit().await
let r = hub.inbound_sso_assignments().patch(...).doit().await

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudidentity1 as cloudidentity1;
use cloudidentity1::api::GoogleAppsCloudidentityDevicesV1ClientState;
use cloudidentity1::{Result, Error};
use std::default::Default;
use cloudidentity1::{CloudIdentity, 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 = CloudIdentity::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 = GoogleAppsCloudidentityDevicesV1ClientState::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.devices().device_users_client_states_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .customer("magna")
             .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()方法的返回值，或者作为可能的中间结果传递给枢纽代理，或者认证代理。

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

上传和下载

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

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

自定义和回调

您可以通过向方法构建器提供代理并在最终doit()调用之前提供代理来更改doit()方法的调用方式。相应的方法将被调用来提供进度信息，并确定系统在失败时应否重试。

代理特质默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

使用方法构建器，您可以通过重复调用它的方法来准备一个动作调用。这些方法始终只接受一个参数，以下陈述对它适用。

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

参数将被复制或克隆到构建器中，以使其与其原始生命周期的独立性。

Cargo功能

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

许可证

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