Struct OAuth2Credentials

#[non_exhaustive]
pub struct OAuth2Credentials {
    pub client_id: Option<String>,
    pub client_secret: Option<String>,
    pub access_token: Option<String>,
    pub refresh_token: Option<String>,
    pub o_auth_request: Option<ConnectorOAuthRequest>,
}

The OAuth 2.0 credentials required for OAuth 2.0 authentication.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

client_id: Option<String>

The identifier for the desired client.

client_secret: Option<String>

The client secret used by the OAuth client to authenticate to the authorization server.

access_token: Option<String>

The access token used to access the connector on your behalf.

refresh_token: Option<String>

The refresh token used to refresh an expired access token.

o_auth_request: Option<ConnectorOAuthRequest>

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

Implementations

impl OAuth2Credentials

pub fn client_id(&self) -> Option<&str>

The identifier for the desired client.

pub fn client_secret(&self) -> Option<&str>

The client secret used by the OAuth client to authenticate to the authorization server.

pub fn access_token(&self) -> Option<&str>

The access token used to access the connector on your behalf.

pub fn refresh_token(&self) -> Option<&str>

The refresh token used to refresh an expired access token.

pub fn o_auth_request(&self) -> Option<&ConnectorOAuthRequest>

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

impl OAuth2Credentials

pub fn builder() -> OAuth2CredentialsBuilder

Creates a new builder-style object to manufacture OAuth2Credentials.

Trait Implementations

impl Clone for OAuth2Credentials

fn clone(&self) -> OAuth2Credentials

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OAuth2Credentials

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for OAuth2Credentials

fn eq(&self, other: &OAuth2Credentials) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OAuth2Credentials