AuthSchemeCard

Domain

Selectable card describing a single auth scheme (apiKey, http, oauth2, openIdConnect, mutualTLS).

OAuth recommended

Preview

OAuth 2.0

OAuth 2.0Recommended

Industry-standard authorisation framework. Suitable for third-party integrations.

Header
Authorization
Flows
Authorization Code
Code
<AuthSchemeCard name="OAuth 2.0" type="oauth2" recommended description="…" href="/auth/oauth2" />

API key

Preview

X-API-Key

API Key

Simple static-key authentication. Best for server-to-server use only.

In
header
Name
X-API-Key
Code
<AuthSchemeCard name="X-API-Key" type="apiKey" description="…" />
Sourcemodules/domains/api-doc/AuthSchemeCard.tsx