Rust API client for tapis_authenticator

REST API and web server providing authentication for a Tapis v3 instance.

For more information, please visit https://tapis-project.org

Overview

This SDK provides both low-level generated API bindings and a high-level ergonomic client wrapper for the Tapis Authenticator API.

• API version: 1
• Package version: 1.0.0
• Generator version: 7.18.0
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named tapis_authenticator and add the following to Cargo.toml under [dependencies]:

tapis_authenticator = { path = "./tapis_authenticator" }

Quick Start

Using the High-Level Client (Recommended)

The TapisAuthenticator client provides an ergonomic interface with automatic JWT authentication:

use tapis_authenticator::client::TapisAuthenticator;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create client with automatic JWT authentication
    let client = TapisAuthenticator::new(
        "https://tacc.tapis.io/v3/authenticator",
        "your_jwt_token"
    )?;

    // Get user information
    let userinfo = client.profiles.get_userinfo().await?;
    println!("User: {:#?}", userinfo);

    // List OAuth2 clients
    let clients = client.clients.list_clients(Some(10), Some(0)).await?;
    println!("Clients: {:#?}", clients);

    // Check server health
    let health = client.health_check.hello().await?;
    println!("Health: {:#?}", health);

    Ok(())
}

Available API Modules

The client provides the following sub-clients:

• client.admin - Tenant configuration management

  • get_config() - Get tenant configuration
  • update_config() - Update tenant configuration

• client.clients - OAuth2 client management

  • list_clients() - List all OAuth2 clients
  • get_client() - Get specific client details
  • create_client() - Create new OAuth2 client
  • update_client() - Update OAuth2 client
  • delete_client() - Delete OAuth2 client

• client.health_check - Service health checks

  • hello() - Basic health check
  • ready() - Readiness check

• client.metadata - Server metadata

  • get_server_metadata() - Get server version and metadata

• client.profiles - User profile management

  • get_userinfo() - Get current user information
  • get_profile() - Get specific user profile
  • list_profiles() - List all profiles

• client.tokens - Token management

  • create_token() - Generate Tapis JWT
  • create_v2_token() - Create v2 bearer token
  • generate_device_code() - Generate device code for device flow
  • revoke_token() - Revoke authentication token

Running the Example

# Set your JWT token
export TAPIS_TOKEN="your_jwt_token"

# Run the example
cargo run --example authenticator_example

Documentation for API Endpoints

All URIs are relative to http://localhost:5000

Documentation For Models

• BasicResponse
• Client
• CreateClient201Response
• CreateToken201Response
• CreateV2Token200Response
• DeleteClient200Response
• DeviceCodeResposne
• GenerateDeviceCode200Response
• GetConfig200Response
• GetServerMetadata200Response
• GetUserinfo200Response
• ListClients200Response
• ListProfiles200Response
• NewClient
• NewDeviceCode
• NewTenantConfig
• NewToken
• OAuth2Metadata
• Profile
• RevokeTokenRequest
• TenantConfig
• TokenResponse
• TokenResponseAccessToken
• TokenResponseRefreshToken
• UpdateClient
• V2Token
• V2TokenResponse

To get access to the crate's generated documentation, use:

cargo doc --open

Author

cicsupport@tacc.utexas.edu