Enum Flow

pub enum Flow {
    OAuth2 {
        authorization_url: Option<String>,
        token_url: Option<String>,
        scopes: HashMap<String, String>,
        refresh_url: Option<String>,
    },
    SignedUrl {
        method: String,
        authorization_api: Option<String>,
        parameters: HashMap<String, Parameter>,
        response_field: Option<String>,
    },
}

The OAuth2 Flow Object applies for oauth2, the Signed URL Object applies to signedUrl.

Variants

OAuth2

Based on the OpenAPI OAuth Flow Object.

Allows configuration of the supported OAuth Flows.

Fields

authorization_url: Option<String>

The authorization URL to be used for this flow.

This MUST be in the form of a URL.

token_url: Option<String>

The token URL to be used for this flow.

This MUST be in the form of a URL.

scopes: HashMap<String, String>

The available scopes for the authentication scheme.

A map between the scope name and a short description for it. The map MAY be empty.

refresh_url: Option<String>

The URL to be used for obtaining refresh tokens.

This MUST be in the form of a URL.

SignedUrl

A signed url flow.

Fields

method: String

The method to be used for requests.

authorization_api: Option<String>

The signed URL API endpoint to be used for this flow.

If not inferred from the client environment, this must be defined in the authentication flow.

parameters: HashMap<String, Parameter>

Parameter definition for requests to the authorizationApi

response_field: Option<String>

Key name for the signed URL field in an authorizationApi response

Trait Implementations

impl Debug for Flow

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Flow

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Flow

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

where __S: Serializer,

Serialize this value into the given Serde serializer.