Getting Started

Welcome to PropelAuth's Backend API documentation! PropelAuth’s backend APIs allow you to manage users, organizations, and API keys programmatically.

Get started by heading over to www.propelauth.com to create an account if you haven't already.

Authentication

The backend API requires an Authorization header with your API key set as a bearer token.

{
  "Authorization": "Bearer {YOUR_API_KEY}"
}

You can find your API key by logging into the PropelAuth dashboard and navigating to the Backend Integration page. Select the environment you want to create the API key for (test, staging, prod) and click on Create New API Key.

Each of your environments are completely separate, meaning you'll need a different API key for each one.

Base URL

The base URL for the backend API is your environment's Auth URL. Head over to the Frontend Integration page in your PropelAuth dashboard to find yours.

Similarly to the API key, you'll need a different Auth URL for each of your environments (test, staging, prod). Your test Auth URL is generated by PropelAuth and will look something like "https://1581439057.propelauthtest.com".

However, your Auth URL for your staging and prod environments are set by you. If your app's domain is "https://acme.com", your Auth URL will be "https://auth.acme.com".

User API Keys

PropelAuth offers the ability for your users to create their own API keys. These API keys cannot be used in the Authentication header for this API. However, you can use the API KEY APIs to create, edit, delete, and validate these API keys for your own API.

Download the Postman Collection

View and test the PropelAuth backend API with our Postman Collection.

1. Download our Postman Collection.
2. Import the collection to your own Postman workspace.
3. Click on the Variables tab, paste in your API credentials, and click Save.