Struct oxide_api::login::Login

pub struct Login {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Login

pub async fn get(&self, provider_name: &str, silo_name: &str) -> Result<()>

Ask the user to login to their identity provider.

This function performs a GET to the /login/{silo_name}/{provider_name} endpoint.

Either display a page asking a user for their credentials, or redirect them to their identity provider.

Parameters:

• provider_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.
• silo_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.

pub async fn consume_credentials(
    &self,
    provider_name: &str,
    silo_name: &str
) -> Result<()>

Consume some sort of credentials, and authenticate a user.

This function performs a POST to the /login/{silo_name}/{provider_name} endpoint.

Either receive a username and password, or some sort of identity provider data (like a SAMLResponse). Use these to set the user’s session cookie.

Parameters:

• provider_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.
• silo_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.