SecurityBadge

Domain

Inline badge representing an API security scheme type with a matching icon and color.

All scheme types

Preview
API KeyHTTPOAuth 2.0OpenID ConnectMutual TLS
Code
<SecurityBadge type="apiKey" />
<SecurityBadge type="http" />
<SecurityBadge type="oauth2" />
<SecurityBadge type="openIdConnect" />
<SecurityBadge type="mutualTLS" />

Custom names

Preview
X-API-KeyOAuth 2.0 (PKCE)Bearer JWT
Code
<SecurityBadge type="apiKey" name="X-API-Key" />
<SecurityBadge type="oauth2" name="OAuth 2.0 (PKCE)" />
<SecurityBadge type="http" name="Bearer JWT" />
Sourcemodules/domains/api-doc/SecurityBadge.tsx