Skip to main content

Clients

Clients represent API consumers in FastGateway, providing identity management for access control through IP addresses, API keys, JWT, and mTLS.

What is a Client?​

A client is an entity that consumes your APIs, such as:

  • External partner applications
  • Internal microservices
  • Mobile applications
  • Third-party integrations

Client Properties​

PropertyDescription
NameHuman-readable identifier
TeamOwning team responsible for the client
IP AddressesAllowed source IPs for IP-based filtering
API KeysSecret keys for API key authentication
JWTPer-client JWT validation (issuer, JWKS, audiences, claims)
mTLSPer-client mutual TLS using a CA and SAN/certificate identity

Client Credentials​

IP Addresses​

Allowed IPs:
- 192.168.1.0/24
- 10.0.0.5

API Keys​

API Key: fg_live_abc123...
Header: x-api-key

JWT​

Issuer: https://issuer.example.com
JWKS URL: https://issuer.example.com/.well-known/jwks.json
Audiences: [api.example.com]

mTLS​

CA: client-ca
SAN: spiffe://example.com/client

Requests are routed to a client using a separate client ID header (x-client-id), independent of the authentication method.

Client Attachments​

Clients connect to routes through attachments, which:

  • Link a client to a specific route
  • Enable client-specific security policies
  • Require approval before activation

Team Ownership​

Each client belongs to a team:

  • Team members manage client credentials
  • Cross-team attachments require dual approval
  • Client deletion removes all attachments

Clients provide the foundation for the Client security mode, enabling per-consumer access control.