Skip to content

Authentication

Authentication methods for Fermi API.

Authentication Methods

API Keys

Credentials for creating organizations and service actors.

API Keys Guide

Service Actors

Non-human entities for automated systems. Created using API keys.

Service Actors Guide

Token Exchange

Convert API keys to short-lived JWT tokens (15 minutes) for data access.

Token Exchange Guide

When to Use

Use Case Method
Create organizations API Keys
Create service actors API Keys
Access data Service Actor Tokens
Automated systems Service Actors + Token Exchange

Quick Reference

  • API Key Format: fmk_live_<key>
  • Token Expiration: 15 minutes
  • Required Scopes: provision:service:create, provision:token:exchange

Scopes Reference