Struct OAuthSource

pub struct OAuthSource {

    pub pk: Uuid,
    pub name: String,
    pub slug: String,
    pub enabled: Option<bool>,
    pub authentication_flow: Option<Option<Uuid>>,
    pub enrollment_flow: Option<Option<Uuid>>,
    pub component: String,
    pub verbose_name: String,
    pub verbose_name_plural: String,
    pub meta_model_name: String,
    pub policy_engine_mode: Option<PolicyEngineMode>,
    pub user_matching_mode: Option<UserMatchingModeEnum>,
    pub managed: Option<String>,
    pub user_path_template: Option<String>,
    pub icon: Option<String>,
    pub provider_type: ProviderTypeEnum,
    pub request_token_url: Option<Option<String>>,
    pub authorization_url: Option<Option<String>>,
    pub access_token_url: Option<Option<String>>,
    pub profile_url: Option<Option<String>>,
    pub consumer_key: String,
    pub callback_url: String,
    pub additional_scopes: Option<String>,
    pub type: Box<SourceType>,
    pub oidc_well_known_url: Option<String>,
    pub oidc_jwks_url: Option<String>,
    pub oidc_jwks: Option<Option<Value>>,
}

OAuthSource : OAuth Source Serializer

Fields

pk: Uuid

name: String

Source’s display Name.

slug: String

Internal source name, used in URLs.

enabled: Option<bool>

authentication_flow: Option<Option<Uuid>>

Flow to use when authenticating existing users.

enrollment_flow: Option<Option<Uuid>>

Flow to use when enrolling new users.

component: String

Get object component so that we know how to edit the object

verbose_name: String

Return object’s verbose_name

verbose_name_plural: String

Return object’s plural verbose_name

meta_model_name: String

Return internal model name

policy_engine_mode: Option<PolicyEngineMode>

user_matching_mode: Option<UserMatchingModeEnum>

How the source determines if an existing user should be authenticated or a new user enrolled. * identifier - Use the source-specific identifier * email_link - Link to a user with identical email address. Can have security implications when a source doesn’t validate email addresses. * email_deny - Use the user’s email address, but deny enrollment when the email address already exists. * username_link - Link to a user with identical username. Can have security implications when a username is used with another source. * username_deny - Use the user’s username, but deny enrollment when the username already exists.

managed: Option<String>

Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.

user_path_template: Option<String>

icon: Option<String>

Get the URL to the Icon. If the name is /static or starts with http it is returned as-is

provider_type: ProviderTypeEnum

request_token_url: Option<Option<String>>

URL used to request the initial token. This URL is only required for OAuth 1.

authorization_url: Option<Option<String>>

URL the user is redirect to to conest the flow.

access_token_url: Option<Option<String>>

URL used by authentik to retrieve tokens.

profile_url: Option<Option<String>>

URL used by authentik to get user information.

consumer_key: String

callback_url: String

Get OAuth Callback URL

additional_scopes: Option<String>

type: Box<SourceType>

oidc_well_known_url: Option<String>

oidc_jwks_url: Option<String>

oidc_jwks: Option<Option<Value>>

Implementations

impl OAuthSource

pub fn new( pk: Uuid, name: String, slug: String, component: String, verbose_name: String, verbose_name_plural: String, meta_model_name: String, managed: Option<String>, icon: Option<String>, provider_type: ProviderTypeEnum, consumer_key: String, callback_url: String, type: SourceType, ) -> OAuthSource

OAuth Source Serializer

Trait Implementations

impl Clone for OAuthSource

fn clone(&self) -> OAuthSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthSource

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

Formats the value using the given formatter.

impl Default for OAuthSource

fn default() -> OAuthSource

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OAuthSource

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OAuthSource

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OAuthSource