Crates.io | google-cloudidentity1 |
lib.rs | google-cloudidentity1 |
version | 5.0.5+20240625 |
source | src |
created_at | 2019-07-05 03:46:30.174171 |
updated_at | 2024-06-27 10:53:14.967912 |
description | A complete library to interact with Cloud Identity (protocol v1) |
homepage | https://cloud.google.com/identity/ |
repository | https://github.com/Byron/google-apis-rs/tree/main/gen/cloudidentity1 |
max_upload_size | |
id | 146090 |
size | 918,128 |
The google-cloudidentity1
library allows access to all features of the Google Cloud Identity service.
This documentation was generated from Cloud Identity crate version 5.0.5+20240625, where 20240625 is the exact revision of the cloudidentity:v1 schema built by the mako code generator v5.0.5.
Everything else about the Cloud Identity v1 API can be found at the official documentation site.
Handle the following Resources with ease from the central hub ...
customers
userinvitations cancel, userinvitations get, userinvitations is invitable user, userinvitations list and userinvitations send
devices
cancel wipe, create, delete, device users approve, device users block, device users cancel wipe, device users client states get, device users client states list, device users client states patch, device users delete, device users get, device users list, device users lookup, device users wipe, get, list and wipe
create, delete, get, get security settings, list, lookup, memberships check transitive membership, memberships create, memberships delete, memberships get, memberships get membership graph, memberships list, memberships lookup, memberships modify membership roles, memberships search direct groups, memberships search transitive groups, memberships search transitive memberships, patch, search and update security settings
create, delete, get, idp credentials add, idp credentials delete, idp credentials get, idp credentials list, list and patch
The API is structured into the following primary items:
All structures are marked with applicable traits to further categorize them and ease browsing.
Generally speaking, you can invoke Activities like this:
let r = hub.resource().activity(...).doit().await
Or specifically ...
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
The resource()
and activity(...)
calls create builders. The second one dealing with Activities
supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
specified right away (i.e. (...)
), whereas all optional ones can be build up as desired.
The doit()
method performs the actual communication with the server and returns the respective result.
To use this library, you would put the following lines into your Cargo.toml
file:
[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),
}
All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.
When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.
If a method supports downloads, the response body, which is part of the Result, should be
read by you to obtain the media.
If such a method also supports a Response Result, it will return that by default.
You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making
this call: .param("alt", "media")
.
Methods supporting uploads can do so using up to 2 different protocols:
simple and resumable. The distinctiveness of each is represented by customized
doit(...)
methods, which are then named upload(...)
and upload_resumable(...)
respectively.
You may alter the way an doit()
method is called by providing a delegate to the
Method Builder before making the final doit()
call.
Respective methods will be called to provide progress information, as well as determine whether the system should
retry on failure.
The delegate trait is default-implemented, allowing you to customize it with minimal effort.
All structures provided by this library are made to be encodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.
Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.
&str
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
utoipa
- Add support for utoipa and derive utoipa::ToSchema
on all
the types. You'll have to import and register the required types in #[openapi(schemas(...))]
, otherwise the
generated openapi
spec would be invalid.
The cloudidentity1 library was generated by Sebastian Thiel, and is placed under the MIT license. You can read the full text at the repository's license file.