Enum AdditionalScope 

pub enum AdditionalScope {
    Email,
    Profile,
    Both,
    None,
}

Optional Scope Parameters

In an OpenID Connect authentication request, the scope parameter specifies the type of user information that should be included in the ID token. By default, the openid scope is required for authentication. This enum allows adding optional scopes, such as email, profile, or both, to the request.

Purpose

AdditionalScope is used to extend the default scope parameter when creating a CodeRequest. It enables applications to request additional user information from Google.

Variants

Email

• Requests the user’s email address and email verification status.
• This is useful if the application needs to identify the user by their email address.

Profile

• Requests the user’s name, profile picture URL, and other basic profile information.
• This is useful for displaying user details in the application.

Both

This allows you to add both Email and Profile scopes

None

No additional scopes are added

Example

use crate::code::AdditionalScope;

let additional_scopes = AdditionalScope::Both;
let request = CodeRequest::new(true, &config, additional_scopes, &csrf_token, &nonce);
let url = request.into_url().unwrap();
println!("Authorization URL: {}", url);

If no additional scopes are specified, the request will only include openid, which is required for authentication.

Notes

• Adding email or profile scopes allows the application to access more detailed user information.
• Ensure that the requested scopes align with the application’s privacy policy and user consent.

Variants

Email

Profile

Both

None

Trait Implementations

impl Clone for AdditionalScope

fn clone(&self) -> AdditionalScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdditionalScope

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

Formats the value using the given formatter.

impl PartialEq for AdditionalScope

fn eq(&self, other: &AdditionalScope) -> 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 AdditionalScope