#active-directory #google #protocols #google-api #api-service #web #web-api

google-managedidentities1

一个完整的库,用于与 Microsoft Active Directory 消费者 API 的托管服务交互(协议 v1)

12 个稳定版本 (4 个主要版本)

5.0.5+20240530 2024年6月27日
5.0.4+20240112 2024年3月5日
5.0.3+20221227 2023年8月24日
5.0.2+20221227 2023年3月16日
1.0.14+20200622 2020年7月10日

#2549 in 网络编程


google-managedidentities1… 中使用

MIT 许可证

1MB
9K SLoC

“google-managedidentities1”库允许访问 Microsoft Active Directory 消费者 API 托管服务(协议 v1)的所有功能。

本文档是从 Managed Service for Microsoft Active Directory Consumer API 的版本 5.0.5+20240530 生成的,其中 20240530 是由 mako 代码生成器 v5.0.5 构建的 managedidentities:v1 架构的确切修订版本。

关于 Microsoft Active Directory 消费者 API v1 API 的其他所有信息都可以在 官方文档网站 上找到。

功能

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

本库的结构

API 被结构化为以下主要项目

  • 中心
  • 资源
    • 主要类型,可以将 活动 应用到这些类型上
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 活动 中从不直接使用
  • 活动
    • 应用于 资源 的操作

所有 结构 都用适用特性标记,以进一步分类它们并便于浏览。

一般来说,您可以像这样调用 活动

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

或者具体地 ...

let r = hub.projects().locations_global_domains_backups_create(...).doit().await
let r = hub.projects().locations_global_domains_backups_delete(...).doit().await
let r = hub.projects().locations_global_domains_backups_patch(...).doit().await
let r = hub.projects().locations_global_domains_attach_trust(...).doit().await
let r = hub.projects().locations_global_domains_create(...).doit().await
let r = hub.projects().locations_global_domains_delete(...).doit().await
let r = hub.projects().locations_global_domains_detach_trust(...).doit().await
let r = hub.projects().locations_global_domains_disable_migration(...).doit().await
let r = hub.projects().locations_global_domains_enable_migration(...).doit().await
let r = hub.projects().locations_global_domains_extend_schema(...).doit().await
let r = hub.projects().locations_global_domains_patch(...).doit().await
let r = hub.projects().locations_global_domains_reconfigure_trust(...).doit().await
let r = hub.projects().locations_global_domains_restore(...).doit().await
let r = hub.projects().locations_global_domains_update_ldapssettings(...).doit().await
let r = hub.projects().locations_global_domains_validate_trust(...).doit().await
let r = hub.projects().locations_global_operations_get(...).doit().await
let r = hub.projects().locations_global_peerings_create(...).doit().await
let r = hub.projects().locations_global_peerings_delete(...).doit().await
let r = hub.projects().locations_global_peerings_patch(...).doit().await

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

使用方法

设置你的项目

要使用此库,你需要在你的Cargo.toml文件中添加以下几行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_managedidentities1 as managedidentities1;
use managedidentities1::api::Backup;
use managedidentities1::{Result, Error};
use std::default::Default;
use managedidentities1::{ManagedServiceForMicrosoftActiveDirectoryConsumerAPI, 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 = ManagedServiceForMicrosoftActiveDirectoryConsumerAPI::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 = Backup::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.projects().locations_global_domains_backups_create(req, "parent")
             .backup_id("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()方法的返回值,或者作为可能的中级结果传递给Hub Delegate,或Authenticator Delegate

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

上传和下载

如果某个方法支持下载,应该由你读取响应体以获取媒体,该响应体是Result的一部分。如果此方法还支持Response Result,则默认返回该值。你可以将其视为实际媒体的数据。要触发媒体下载,你将需要通过以下调用设置构建器:.param("alt", "media")

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

自定义和回调

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

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

服务器请求中的可选部分

本库提供的所有结构都设计为可以通过json进行编码和解码。使用可选参数来表示部分请求和响应是有效的。大多数可选参数都是部分,可以通过名称识别,这些部分将被发送到服务器以指示请求的集合部分或响应中希望包含的部分。

构建器参数

通过使用方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受一个参数,以下陈述适用于该参数。

  • 数据结构(PODs)通过复制传递
  • 字符串作为&str传递
  • 请求值被移动

参数将被复制或克隆到构建器中,以确保它们与其原始生命周期独立。

Cargo功能

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

许可

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

依赖项

~12–22MB
~342K SLoC