Struct splinter::oauth::OpenIdOAuthClientBuilder

pub struct OpenIdOAuthClientBuilder { /* fields omitted */ }

Builds a new OAuthClient using an OpenID discovery document.

Implementations

impl OpenIdOAuthClientBuilder

pub fn new() -> Self

Constructs a new OpenIdOAuthClientBuilder.

pub fn new_azure() -> Self

Constructs a new OpenIdOAuthClientBuilder that’s pre-configured with the scope for getting refresh tokens.

pub fn new_google() -> Self

Constructs a new OpenIdOAuthClientBuilder that’s pre-configured with Google’s discovery URL and the extra authorization code request parameter for getting refresh tokens.

pub fn with_client_id(self, client_id: String) -> Self

Sets the client ID for the OAuth2 provider.

pub fn with_client_secret(self, client_secret: String) -> Self

Sets the client secret for the OAuth2 provider.

pub fn with_extra_auth_params(
    self,
    extra_auth_params: Vec<(String, String)>
) -> Self

Sets extra parameters that will be added to an authorization request.

pub fn with_scopes(self, scopes: Vec<String>) -> Self

Sets the scopes to request from the OAuth2 provider.

pub fn with_inflight_request_store(
    self,
    inflight_request_store: Box<dyn InflightOAuthRequestStore>
) -> Self

Sets the in-flight request store in order to store values between requests to and from the OAuth2 provider.

pub fn with_redirect_url(self, redirect_url: String) -> Self

Sets the redirect URL for the OAuth2 provider.

pub fn with_discovery_url(self, discovery_url: String) -> Self

Sets the discovery document URL for the OpenID Connect provider.

pub fn build(self) -> Result<OAuthClient, OAuthClientBuildError>

Builds an OAuthClient based on the OpenID provider’s discovery document.

Errors

Returns an OAuthClientBuildError if there are required fields missing, if any URL’s provided are invalid or it is unable to load the discovery document.

Trait Implementations

impl Default for OpenIdOAuthClientBuilder

fn default() -> Self

Returns the “default value” for a type.