Struct BeginAuthResult 

pub struct BeginAuthResult {
    pub auth_url: String,
    pub state: StateParam,
}

Result of initiating OAuth authorization.

This struct contains the authorization URL to redirect users to and the state parameter that should be persisted (typically in a session or cookie) for verification when the callback is received.

Important

The state value must be stored by your application and passed to validate_auth_callback when handling the callback. This is essential for CSRF protection.

Example

let result = begin_auth(&config, &shop, "/callback", true, None)?;

// Store in session (implementation depends on your web framework)
session.set("oauth_state", result.state.as_ref());

// Redirect to Shopify
return Redirect::to(&result.auth_url);

Fields

auth_url: String

The full authorization URL to redirect the user to.

This URL points to Shopify’s OAuth authorization endpoint with all required query parameters.

state: StateParam

The state parameter generated for this authorization request.

Store this value and compare it against the state parameter in the OAuth callback to prevent CSRF attacks.

Trait Implementations

impl Clone for BeginAuthResult

fn clone(&self) -> BeginAuthResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BeginAuthResult

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

Formats the value using the given formatter.