Crate google_identitytoolkit3

This documentation was generated from Identity Toolkit crate version 1.0.10+20180723, where 20180723 is the exact revision of the identitytoolkit:v3 schema built by the mako code generator v1.0.10.

Everything else about the Identity Toolkit v3 API can be found at the official documentation site. The original source code is on github.

Features

Handle the following Resources with ease from the central hub ...

• relyingparty
• create auth uri, delete account, download account, email link signin, get account info, get oob confirmation code, get project config, get public keys, get recaptcha param, reset password, send verification code, set account info, set project config, sign out user, signup new user, upload account, verify assertion, verify custom token, verify password and verify phone number

Not what you are looking for ? Find all other Google APIs in their Rust documentation index.

Structure of this Library

The API is structured into the following primary items:

• Hub
  • a central object to maintain state and allow accessing all Activities
  • creates Method Builders which in turn allow access to individual Call Builders
• Resources
  • primary types that you can apply Activities to
  • a collection of properties and Parts
  • Parts
    • a collection of properties
    • never directly used in Activities
• Activities
  • operations to apply to Resources

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()

Or specifically ...

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

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.

Usage

Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

[dependencies]
google-identitytoolkit3 = "*"
# This project intentionally uses an old version of Hyper. See
# https://github.com/Byron/google-apis-rs/issues/173 for more
# information.
hyper = "^0.10"
hyper-rustls = "^0.6"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_identitytoolkit3 as identitytoolkit3;
use identitytoolkit3::IdentitytoolkitRelyingpartyVerifyAssertionRequest;
use identitytoolkit3::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use identitytoolkit3::IdentityToolkit;
 
// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
                              <MemoryStorage as Default>::default(), None);
let mut hub = IdentityToolkit::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), 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();
 
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::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

Handling Errors

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.

Uploads and Downloads

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.

Customization and Callbacks

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.

Optional Parts in Server-Requests

All structures provided by this library are made to be enocodable 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.

Builder Arguments

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.

• PODs are handed by copy
• strings are passed as &str
• request values are moved

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Structs

Chunk
ContentRange	Implements the Content-Range header, for serialization only
CreateAuthUriResponse	Response of creating the IDP authentication URL.
DefaultDelegate	A delegate with a conservative default implementation, which is used if no other delegate is set.
DeleteAccountResponse	Respone of deleting account.
DownloadAccountResponse	Response of downloading accounts in batch.
DummyNetworkStream
EmailLinkSigninResponse	Response of email signIn.
EmailTemplate	Template for an email template.
ErrorResponse	A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound
GetAccountInfoResponse	Response of getting account information.
GetOobConfirmationCodeResponse	Response of getting a code for user confirmation (reset password, change email etc.).
GetRecaptchaParamResponse	Response of getting recaptcha param.
IdentityToolkit	Central instance to access all IdentityToolkit related resource activities
IdentitytoolkitRelyingpartyCreateAuthUriRequest	Request to get the IDP authentication URL.
IdentitytoolkitRelyingpartyDeleteAccountRequest	Request to delete account.
IdentitytoolkitRelyingpartyDownloadAccountRequest	Request to download user account in batch.
IdentitytoolkitRelyingpartyEmailLinkSigninRequest	Request to sign in with email.
IdentitytoolkitRelyingpartyGetAccountInfoRequest	Request to get the account information.
IdentitytoolkitRelyingpartyGetProjectConfigResponse	Response of getting the project configuration.
IdentitytoolkitRelyingpartyGetPublicKeysResponse	Respone of getting public keys.
IdentitytoolkitRelyingpartyResetPasswordRequest	Request to reset the password.
IdentitytoolkitRelyingpartySendVerificationCodeRequest	Request for Identitytoolkit-SendVerificationCode
IdentitytoolkitRelyingpartySendVerificationCodeResponse	Response for Identitytoolkit-SendVerificationCode
IdentitytoolkitRelyingpartySetAccountInfoRequest	Request to set the account information.
IdentitytoolkitRelyingpartySetProjectConfigRequest	Request to set the project configuration.
IdentitytoolkitRelyingpartySetProjectConfigResponse	Response of setting the project configuration.
IdentitytoolkitRelyingpartySignOutUserRequest	Request to sign out user.
IdentitytoolkitRelyingpartySignOutUserResponse	Response of signing out user.
IdentitytoolkitRelyingpartySignupNewUserRequest	Request to signup new user, create anonymous user or anonymous user reauth.
IdentitytoolkitRelyingpartyUploadAccountRequest	Request to upload user account in batch.
IdentitytoolkitRelyingpartyVerifyAssertionRequest	Request to verify the IDP assertion.
IdentitytoolkitRelyingpartyVerifyCustomTokenRequest	Request to verify a custom token
IdentitytoolkitRelyingpartyVerifyPasswordRequest	Request to verify the password.
IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest	Request for Identitytoolkit-VerifyPhoneNumber
IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse	Response for Identitytoolkit-VerifyPhoneNumber
IdpConfig	Template for a single idp configuration.
JsonServerError	A utility type which can decode a server response that indicates error
MethodInfo	Contains information about an API request.
MultiPartReader	Provides a Read interface that converts multiple parts into the protocol identified by RFC2387. Note: This implementation is just as rich as it needs to be to perform uploads to google APIs, and might not be a fully-featured implementation.
RangeResponseHeader
Relyingparty	Request of getting a code for user confirmation (reset password, change email etc.)
RelyingpartyCreateAuthUriCall	Creates the URI used by the IdP to authenticate the user.
RelyingpartyDeleteAccountCall	Delete user account.
RelyingpartyDownloadAccountCall	Batch download user accounts.
RelyingpartyEmailLinkSigninCall	Reset password for a user.
RelyingpartyGetAccountInfoCall	Returns the account info.
RelyingpartyGetOobConfirmationCodeCall	Get a code for user action confirmation.
RelyingpartyGetProjectConfigCall	Get project configuration.
RelyingpartyGetPublicKeyCall	Get token signing public key.
RelyingpartyGetRecaptchaParamCall	Get recaptcha secure param.
RelyingpartyMethods	A builder providing access to all methods supported on relyingparty resources. It is not used directly, but through the IdentityToolkit hub.
RelyingpartyResetPasswordCall	Reset password for a user.
RelyingpartySendVerificationCodeCall	Send SMS verification code.
RelyingpartySetAccountInfoCall	Set account info for a user.
RelyingpartySetProjectConfigCall	Set project configuration.
RelyingpartySignOutUserCall	Sign out user.
RelyingpartySignupNewUserCall	Signup new user.
RelyingpartyUploadAccountCall	Batch upload existing user accounts.
RelyingpartyVerifyAssertionCall	Verifies the assertion returned by the IdP.
RelyingpartyVerifyCustomTokenCall	Verifies the developer asserted ID token.
RelyingpartyVerifyPasswordCall	Verifies the user entered password.
RelyingpartyVerifyPhoneNumberCall	Verifies ownership of a phone number and creates/updates the user account accordingly.
ResetPasswordResponse	Response of resetting the password.
ResumableUploadHelper	A utility type to perform a resumable upload from start to end.
ServerError
ServerMessage
SetAccountInfoResponse	Respone of setting the account information.
SetAccountInfoResponseProviderUserInfo	The user's profiles at the associated IdPs.
SignupNewUserResponse	Response of signing up new user, creating anonymous user or anonymous user reauth.
UploadAccountResponse	Respone of uploading accounts in batch.
UploadAccountResponseError	The error encountered while processing the account info.
UserInfo	Template for an individual account info.
UserInfoProviderUserInfo	The IDP of the user.
VerifyAssertionResponse	Response of verifying the IDP assertion.
VerifyCustomTokenResponse	Response from verifying a custom token
VerifyPasswordResponse	Request of verifying the password.
XUploadContentType	The X-Upload-Content-Type header.

Enums

Error
Scope	Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.

Traits

CallBuilder	Identifies types which represent builders for a particular resource method
Delegate	A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation.
Hub	Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily.
MethodsBuilder	Identifies types for building methods of a particular resource type
NestedType	Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness.
Part	Identifies types which are only used as part of other types, which usually are carrying the Resource trait.
ReadSeek	A utility to specify reader types which provide seeking capabilities too
RequestValue	Identifies types which are used in API requests.
Resource	Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API.
ResponseResult	Identifies types which are used in API responses.
ToParts	A trait for all types that can convert themselves into a parts string
UnusedType	Identifies types which are not actually used by the API This might be a bug within the google API schema.

Functions

remove_json_null_values

Type Definitions

Result

A universal result type used as return for all calls.