Open Source API Gateway

membrane

Version

Syntax

membrane:
src: <string> # required
'$ref': <string>
claims: <string>
claimsIdt: <string>
clientAuthorization: client_secret_basic
clientId: <string>
clientSecret: <string>
httpClientConfiguration: <string>
internalSrc: <string>
jwksRefreshInterval: <int>
registration: {}
responseModesSupported: <string>
scope: <string>
ssl: {}
subject: <string>
useJWTForClientAuth: <boolean>
membrane:
  src: <string> # required
  '$ref': <string>
  claims: <string>
  claimsIdt: <string>
  clientAuthorization: client_secret_basic
  clientId: <string>
  clientSecret: <string>
  httpClientConfiguration: <string>
  internalSrc: <string>
  jwksRefreshInterval: <int>
  registration: {}
  responseModesSupported: <string>
  scope: <string>
  ssl: {}
  subject: <string>
  useJWTForClientAuth: <boolean>

Attributes

NameRequiredDefaultDescriptionExamples
$reffalse-Reference a component defined under components.-
claimsfalse-claims that are requested for the userinfo endpoint-
claimsIdtfalse-claims that are requested for the id_token-
clientAuthorizationfalseclient_secret_basicClient Authorization method (see OIDC Core 1.0 chapter 9-
clientIdfalse---
clientSecretfalse---
httpClientConfigurationfalse---
internalSrcfalse---
jwksRefreshIntervalfalse---
responseModesSupportedfalseform_post query fragmentComma- or blank-separated preference list of response modes (highest priority first). Example:-
scopefalse---
srctrue---
subjectfalse---
useJWTForClientAuthfalse---

Child Structure

ElementCardinalityDescription
registration0..1
ssl0..1Configures a TLS context: the identity (key and certificate) presented to the peer, the certificates trusted from it, and handshake parameters such as protocol, ciphers, and client-certificate policy. Attach it to a serviceProxy/api to terminate inbound TLS, or to a target to make an outbound connection over TLS; most attributes and child elements apply to both directions, but a few - such as clientAuth and useAsDefault - only take effect on an inbound context. See tutorials/ssl-tls/10-TLS-Termination.yaml for inbound termination and tutorials/ssl-tls/20-Central-SSL-Config.yaml for sharing one ssl across several APIs via $ref.

Can be used in