LinuxCommandLibrary

propelauth

Manage and interact with PropelAuth services

TLDR

Login to PropelAuth using an API Key generated from

$ propelauth login
copy

Set the default PropelAuth Project for the CLI. If no default project is set, the system will prompt for selecting a Project each time certain commands are run
$ propelauth set-default-project
copy

Install PropelAuth authentication in an application. If no directory is provided, the current directory is used
$ propelauth setup [[-f|--framework]] [path/to/directory]
copy

Log the CLI out of PropelAuth
$ propelauth logout
copy

SYNOPSIS

propelauth [options] [arguments]

PARAMETERS

login
    Authenticates the CLI tool with your PropelAuth account, typically by prompting for credentials or an API key.

users
    Manages user accounts within your PropelAuth tenant. Common subcommands include create, get, update, and delete. For example, propelauth users create --email example@domain.com --password .

organizations
    Administers organizations and their members. Subcommands could include create, get, update, delete, and add-user. For instance, propelauth organizations add-user --org-id --user-id --role Member.

api-keys
    Manages API keys for various services and integrations within your PropelAuth tenant, allowing for creation, listing, and revocation.

config
    Displays and manages the local PropelAuth CLI configuration, such as API endpoints and default credentials for different tenants or environments.

env
    Sets up local development environment variables and SDK configurations for PropelAuth integration, aiding in quick project setup and testing.

--help
    Displays help information for the main command or a specific subcommand, detailing available options and usage.

--version
    Shows the installed version of the PropelAuth CLI tool.

DESCRIPTION

PropelAuth is an authentication and authorization platform for B2B SaaS applications. It provides robust tools for managing user authentication, single sign-on (SSO), organization roles, and access control. While primarily integrated via SDKs and web dashboards, a conceptual propelauth command-line interface (CLI) would offer developers and administrators direct, scriptable interaction with their PropelAuth tenants. This theoretical CLI would streamline common administrative tasks such as creating and managing users, organizations, and API keys, configuring development environments, and debugging authentication flows, thereby enhancing automation and operational efficiency for teams utilizing PropelAuth services. It would serve as a powerful tool for integrating authentication workflows into CI/CD pipelines and backend scripts.

CAVEATS

It is important to note that a widely distributed, official standalone 'propelauth' command-line interface (CLI) in the traditional Linux utility sense is not prominently available or documented by PropelAuth. Interactions with PropelAuth are typically handled through their SDKs, direct API calls, or the web dashboard. The analysis provided here for a 'propelauth' command is largely based on hypothetical functionalities that such a CLI would offer if it existed, synthesizing common CLI patterns and PropelAuth's core services. Users should refer to PropelAuth's official documentation for current best practices regarding API and SDK usage.

PRIMARY INTEGRATION METHODS

PropelAuth is primarily integrated into applications using language-specific SDKs (e.g., Python, Node.js, React) or direct REST API calls. These methods allow developers to embed authentication flows, manage user sessions, and enforce authorization rules directly within their application code. The PropelAuth web dashboard also provides a comprehensive interface for administrative tasks, including user management, organization configuration, and SSO setup.

HISTORY

PropelAuth was founded to simplify user authentication and authorization for B2B SaaS companies, addressing the complexities often faced in building secure and scalable authentication systems from scratch. Launched to provide a robust, developer-friendly platform, it aims to abstract away the intricacies of identity management, including multi-tenancy, SSO, and role-based access control. While the service itself has evolved since its inception, focusing on API-first design and comprehensive SDKs for various programming languages, a dedicated, general-purpose command-line interface (CLI) for system-wide management has not been a primary focus of its public development. Instead, emphasis has been placed on programmatic integration via APIs and SDKs.

SEE ALSO

curl(1), jq(1), aws(1)

Copied to clipboard