f5xc-auth¶

Shared authentication library for F5 Distributed Cloud XDG-compliant profile management and credential handling for TypeScript/Node.js

Overview¶

@robinmordasiewicz/f5xc-auth is a TypeScript authentication library designed for F5 Distributed Cloud (XC) applications. It provides a unified interface for credential management, profile storage, and HTTP client configuration.

Key Benefits:

XDG-compliant storage - Profiles stored securely in ~/.config/f5xc/profiles/
Multiple auth methods - API tokens, P12 certificates, or certificate/key pairs
Environment priority - Override profiles with environment variables for CI/CD
URL normalization - Automatic handling of various F5 XC tenant URL formats
Pre-configured HTTP - Axios client with authentication and retry logic
Type-safe - Full TypeScript support with comprehensive type definitions

Installation¶

npm¶

npm install @robinmordasiewicz/f5xc-auth

yarn¶

yarn add @robinmordasiewicz/f5xc-auth

pnpm¶

pnpm add @robinmordasiewicz/f5xc-auth

Requirements:

Node.js 18 or later
Valid F5 Distributed Cloud tenant credentials

Getting Started¶

Authentication

Configure authentication with API tokens, P12 certificates, or certificate/key pairs

Quick Start

Get started with basic authentication and API calls

Guides

Practical guides for common workflows and features

API Reference

Complete API documentation for all classes and functions

Examples

Real-world code examples demonstrating library usage

Troubleshooting

Common issues and solutions with debug mode tips

Next Steps¶

New users: Start with Authentication to configure your credentials
Developers: Explore Guides for common workflows
API integration: Check the API Reference for detailed documentation
Need help: Visit Troubleshooting for solutions to common issues