Struct yup_oauth2::authenticator::AuthenticatorBuilder

pub struct AuthenticatorBuilder<C, F> { /* private fields */ }

Configure an Authenticator using the builder pattern.

Implementations

impl<C, F> AuthenticatorBuilder<C, F>

Methods available when building any Authenticator.

    let authenticator = yup_oauth2::DeviceFlowAuthenticator::builder(app_secret)
        .hyper_client(custom_hyper_client)
        .persist_tokens_to_disk("/tmp/tokenfile.json")
        .build()
        .await
        .expect("failed to create authenticator");

pub fn with_storage(self, storage: Box<dyn TokenStorage>) -> Self

Use the provided token storage mechanism

pub fn hyper_client<NewC>( self, hyper_client: Client<NewC, String>, ) -> AuthenticatorBuilder<Client<NewC, String>, F>

Use the provided hyper client.

pub fn persist_tokens_to_disk<P: Into<PathBuf>>( self, path: P, ) -> AuthenticatorBuilder<C, F>

Persist tokens to disk in the provided filename.

impl<C> AuthenticatorBuilder<C, DeviceFlow>

Methods available when building a device flow Authenticator.

    let authenticator = yup_oauth2::DeviceFlowAuthenticator::builder(app_secret)
        .device_code_url("foo")
        .flow_delegate(Box::new(custom_flow_delegate))
        .grant_type("foo")
        .build()
        .await
        .expect("failed to create authenticator");

pub fn device_code_url(self, url: impl Into<Cow<'static, str>>) -> Self

Use the provided device code url.

pub fn flow_delegate(self, flow_delegate: Box<dyn DeviceFlowDelegate>) -> Self

Use the provided DeviceFlowDelegate.

pub fn grant_type(self, grant_type: impl Into<Cow<'static, str>>) -> Self

Use the provided grant type.

pub async fn build(self) -> Result<Authenticator<C::Connector>>

where C: HyperClientBuilder,

Create the authenticator.

impl<C> AuthenticatorBuilder<C, InstalledFlow>

Methods available when building an installed flow Authenticator.

    let authenticator = yup_oauth2::InstalledFlowAuthenticator::builder(
        app_secret,
        InstalledFlowReturnMethod::HTTPRedirect,
    )
    .flow_delegate(Box::new(custom_flow_delegate))
    .build()
    .await
    .expect("failed to create authenticator");

pub fn flow_delegate( self, flow_delegate: Box<dyn InstalledFlowDelegate>, ) -> Self

Use the provided InstalledFlowDelegate.

pub fn force_account_selection(self, force: bool) -> Self

Force the user to select an account on the initial request

pub async fn build(self) -> Result<Authenticator<C::Connector>>

where C: HyperClientBuilder,

Create the authenticator.

impl<C> AuthenticatorBuilder<C, ServiceAccountFlowOpts>

Methods available when building a service account authenticator.

    let authenticator = yup_oauth2::ServiceAccountAuthenticator::builder(
        service_account_key,
    )
    .subject("mysubject")
    .build()
    .await
    .expect("failed to create authenticator");

pub fn subject(self, subject: impl Into<String>) -> Self

Use the provided subject.

pub async fn build(self) -> Result<Authenticator<C::Connector>>

where C: HyperClientBuilder,

Create the authenticator.

impl<C> AuthenticatorBuilder<C, ApplicationDefaultCredentialsFlowOpts>

pub async fn build(self) -> Result<Authenticator<C::Connector>>

where C: HyperClientBuilder,

Create the authenticator.

impl<C> AuthenticatorBuilder<C, AuthorizedUserFlow>

Methods available when building an authorized user flow Authenticator.

pub async fn build(self) -> Result<Authenticator<C::Connector>>

where C: HyperClientBuilder,

Create the authenticator.

impl<C> AuthenticatorBuilder<C, ExternalAccountFlow>

Methods available when building an external account flow Authenticator.

pub async fn build(self) -> Result<Authenticator<C::Connector>>

where C: HyperClientBuilder,

Create the authenticator.

impl<C> AuthenticatorBuilder<C, ServiceAccountImpersonationFlow>

Methods available when building a service account impersonation Authenticator.

pub async fn build(self) -> Result<Authenticator<C::Connector>>

where C: HyperClientBuilder,

Create the authenticator.

pub fn request_id_token(self) -> Self

Configure this authenticator to impersonate an ID token (rather an an access token, as is the default).

For more on impersonating ID tokens, see google’s docs.

impl<C> AuthenticatorBuilder<C, AccessTokenFlow>

Methods available when building an access token flow Authenticator.

pub async fn build(self) -> Result<Authenticator<C::Connector>>

where C: HyperClientBuilder,

Create the authenticator.