Struct kittycad::hidden::Hidden

pub struct Hidden {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Hidden

pub async fn auth_email<'a>( &'a self, body: &EmailAuthenticationForm ) -> Result<VerificationTokenResponse, Error>

Create an email verification request for a user.

async fn example_hidden_auth_email() -> anyhow::Result<()> {
    let client = kittycad::Client::new_from_env();
    let result: kittycad::types::VerificationTokenResponse = client
        .hidden()
        .auth_email(&kittycad::types::EmailAuthenticationForm {
            callback_url: Some("https://example.com/foo/bar".to_string()),
            email: "email@example.com".to_string(),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn auth_email_callback<'a>( &'a self, callback_url: Option<String>, email: &'a str, token: &'a str ) -> Result<(), Error>

Listen for callbacks for email verification for users.

Parameters:

• callback_url: Option<String>: The URL to redirect back to after we have authenticated.
• email: &'astr: The user’s email. (required)
• token: &'astr: The verification token. (required)

async fn example_hidden_auth_email_callback() -> anyhow::Result<()> {
    let client = kittycad::Client::new_from_env();
    client
        .hidden()
        .auth_email_callback(
            Some("https://example.com/foo/bar".to_string()),
            "email@example.com",
            "some-string",
        )
        .await?;
    Ok(())
}

pub async fn get_auth_saml<'a>( &'a self, callback_url: Option<String>, provider_id: Uuid ) -> Result<(), Error>

Get a redirect straight to the SAML IdP.

The UI uses this to avoid having to ask the API anything about the IdP. It already knows the SAML IdP ID from the path, so it can just link to this path and rely on the API to redirect to the actual IdP.

Parameters:

• callback_url: Option<String>: The URL to redirect back to after we have authenticated.
• provider_id: uuid::Uuid: The ID of the identity provider. (required)

use std::str::FromStr;
async fn example_hidden_get_auth_saml() -> anyhow::Result<()> {
    let client = kittycad::Client::new_from_env();
    client
        .hidden()
        .get_auth_saml(
            Some("https://example.com/foo/bar".to_string()),
            uuid::Uuid::from_str("d9797f8d-9ad6-4e08-90d7-2ec17e13471c")?,
        )
        .await?;
    Ok(())
}

pub async fn post_auth_saml<'a>( &'a self, provider_id: Uuid, body: &Bytes ) -> Result<(), Error>

Authenticate a user via SAML

Parameters:

• provider_id: uuid::Uuid: The ID of the identity provider. (required)

use std::str::FromStr;
async fn example_hidden_post_auth_saml() -> anyhow::Result<()> {
    let client = kittycad::Client::new_from_env();
    client
        .hidden()
        .post_auth_saml(
            uuid::Uuid::from_str("d9797f8d-9ad6-4e08-90d7-2ec17e13471c")?,
            &bytes::Bytes::from("some-string"),
        )
        .await?;
    Ok(())
}

pub async fn logout<'a>(&'a self) -> Result<(), Error>

This endpoint removes the session cookie for a user.

This is used in logout scenarios.

async fn example_hidden_logout() -> anyhow::Result<()> {
    let client = kittycad::Client::new_from_env();
    client.hidden().logout().await?;
    Ok(())
}

Trait Implementations

impl Clone for Hidden

fn clone(&self) -> Hidden

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hidden

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

Formats the value using the given formatter.