Struct ServiceAuth 

pub struct ServiceAuth {
    pub scheme: String,
    pub auth_url: Option<String>,
    pub token_url: Option<String>,
    pub scopes: Vec<String>,
    pub header: Option<String>,
    pub client_id_setting: Option<String>,
    pub credentials_help_url: Option<String>,
}

Auth contract for a service integration. scheme selects the strategy; the remaining fields are the declarative parameters that strategy needs.

Fields

scheme: String

One of oauth2 | bearer | basic | api_key.

auth_url: Option<String>

OAuth2 authorization endpoint (scheme == oauth2).

token_url: Option<String>

OAuth2 token endpoint (scheme == oauth2).

scopes: Vec<String>

OAuth2 scopes requested at consent.

header: Option<String>

Request header carrying the credential for api_key / bearer (e.g. Authorization, X-Api-Key). Defaults to Authorization.

client_id_setting: Option<String>

Settings key holding the operator-supplied OAuth client id (scheme == oauth2).

credentials_help_url: Option<String>

Optional provider console URL where the user obtains the credentials (e.g. the OAuth client id + secret). Shown as a help link in Settings. A branded URL - authored as catalog data, never hard-coded in the UI.

Implementations

impl ServiceAuth

pub fn header_name(&self) -> &str

The header carrying the credential, defaulting to Authorization.

Trait Implementations

impl Clone for ServiceAuth

fn clone(&self) -> ServiceAuth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceAuth

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServiceAuth

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ServiceAuth

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

where __S: Serializer,

Serialize this value into the given Serde serializer.