Struct OAuth2Authentication 

pub struct OAuth2Authentication {
    pub email: Option<String>,
    pub name: Option<String>,
    pub sub: String,
    pub type_: OAuth2ProviderType,
    pub username: Option<String>,
}

Information about an end user who authenticates using a third-party provider.

JSON schema

{
 "title": "OAuth2Authentication",
 "description": "Information about an end user who authenticates using a third-party provider.",
 "type": "object",
 "required": [
   "sub",
   "type"
 ],
 "properties": {
   "email": {
     "description": "The email address of the end user contained within the user's ID token, if available from third-party OAuth2 provider's token exchange.",
     "examples": [
       "test.user@gmail.com"
     ],
     "type": "string"
   },
   "name": {
     "description": "The full name of the end user if available from third-party OAuth2 provider's token exchange.",
     "examples": [
       "Test User"
     ],
     "type": "string"
   },
   "sub": {
     "description": "The unique identifier for the end user that is captured in the `sub` claim of the JWT.",
     "examples": [
       "e051beeb-7163-4527-a5b6-35e301529ff2"
     ],
     "type": "string"
   },
   "type": {
     "$ref": "#/components/schemas/OAuth2ProviderType"
   },
   "username": {
     "description": "The username of the end user if available from third-party OAuth2 provider's token exchange.",
     "examples": [
       "test.user"
     ],
     "type": "string"
   }
 }
}

Fields

email: Option<String>

The email address of the end user contained within the user’s ID token, if available from third-party OAuth2 provider’s token exchange.

name: Option<String>

The full name of the end user if available from third-party OAuth2 provider’s token exchange.

sub: String

The unique identifier for the end user that is captured in the sub claim of the JWT.

type_: OAuth2ProviderType

username: Option<String>

The username of the end user if available from third-party OAuth2 provider’s token exchange.

Implementations

impl OAuth2Authentication

pub fn builder() -> OAuth2Authentication

Trait Implementations

impl Clone for OAuth2Authentication

fn clone(&self) -> OAuth2Authentication

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuth2Authentication

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OAuth2Authentication

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&OAuth2Authentication> for OAuth2Authentication

fn from(value: &OAuth2Authentication) -> Self

Converts to this type from the input type.

impl From<OAuth2Authentication> for AuthenticationMethod

fn from(value: OAuth2Authentication) -> Self

Converts to this type from the input type.

impl From<OAuth2Authentication> for OAuth2Authentication

fn from(value: OAuth2Authentication) -> Self

Converts to this type from the input type.

impl Serialize for OAuth2Authentication

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<OAuth2Authentication> for OAuth2Authentication

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: OAuth2Authentication) -> Result<Self, ConversionError>

Performs the conversion.