Enum AuthConfigDto 

pub enum AuthConfigDto {
    Bearer {
        token_env: ConfigValue<String>,
    },
    ApiKey {
        location: ApiKeyLocationDto,
        name: ConfigValue<String>,
        value_env: ConfigValue<String>,
    },
    Basic {
        username_env: ConfigValue<String>,
        password_env: Option<ConfigValue<String>>,
    },
    OAuth2ClientCredentials {
        token_url: ConfigValue<String>,
        client_id_env: ConfigValue<String>,
        client_secret_env: ConfigValue<String>,
        scopes: Vec<ConfigValue<String>>,
    },
}

Authentication configuration DTO.

Variants

Bearer

Bearer token authentication.

Fields

token_env: ConfigValue<String>

Environment variable containing the token.

ApiKey

API key authentication (in header or query parameter).

Fields

location: ApiKeyLocationDto

Where to send the API key.

name: ConfigValue<String>

Header name or query parameter name.

value_env: ConfigValue<String>

Environment variable containing the API key value.

Basic

HTTP Basic authentication.

Fields

username_env: ConfigValue<String>

Environment variable containing the username.

password_env: Option<ConfigValue<String>>

Environment variable containing the password.

OAuth2ClientCredentials

OAuth2 Client Credentials flow.

Fields

token_url: ConfigValue<String>

Token endpoint URL.

client_id_env: ConfigValue<String>

Environment variable containing the client ID.

client_secret_env: ConfigValue<String>

Environment variable containing the client secret.

scopes: Vec<ConfigValue<String>>

Optional scopes to request.

Trait Implementations

impl Clone for AuthConfigDto

fn clone(&self) -> AuthConfigDto

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthConfigDto

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthConfigDto

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AuthConfigDto

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

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 AuthConfigDto

impl<'__s> ToSchema<'__s> for AuthConfigDto

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.