← Back to plugin index

API Policy Service
Description
Configures the API Policy Service web application.

This web application currently offers a REST endpoint targeted at Airlock WAF that allows to retrieve information about a technical client by resolving a given API key. Among other, the returned information contains details about the technical client and associated plans (including rate limits).

Type name
ApiPolicyServiceApp
Class
com.airlock.iam.apipolicyservice.application.configuration.ApiPolicyServiceAppConfig
License-Tags
ApiPolicyService
Properties
Repository (repository)
Description
A repository that allows to configure the DB access concerning API policy service functionality.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Technical Client Database Repository
Shared Secret (sharedSecret)
Description

Shared secret to verify the JWT signature. Must be the same as on the Airlock Gateway (WAF) using this API Policy Service endpoint.

The shared secret must be encoded in base64. The minimal required unencoded length is at least 512 bits. Configuration validation fails if the secret is too short.

One can, for example, generate a random secret with 512 bits (64 bytes) as base64 encoded string using openssl as follows: openssl rand -base64 96

Attributes
String
Mandatory
Sensitive
Context Extractor (contextExtractor)
Description
Specifies how a context is to be extracted from a request.
Attributes
Plugin-Link
Optional
Assignable plugins
Client Certificate Context Extractor Combining Context Extractor Concatenating Context Extractor HTTP Query Parameter Context Extractor IP Address Context Extractor No Context Extractor Static Context Extractor URL Context Extractor
Log User Trail To Database (logUserTrailToDatabase)
Description

Configures the database settings to use when persisting user trail log entries.

If this value is defined, then all user trail log messages generated by the API Policy Service App module will additionally be forwarded to the database configured within the referenced repository plugin.

All forwarded log entries are stored inside the table "USER_TRAIL_LOG". Note that setting this value does not disable writing log messages to the API Policy Service log file.

Attributes
Plugin-Link
Optional
Assignable plugins
User Trail Log Database Repository
Correlation ID Settings (correlationIdSettings)
Description

Defines settings for correlation ID transfer and logging inside the Api Policy Service module.

If undefined, no correlation ID will be logged for this module.

Attributes
Plugin-Link
Optional
Assignable plugins
Correlation ID Settings
YAML Template (with default values) 

type: ApiPolicyServiceApp
id: ApiPolicyServiceApp-xxxxxx
displayName: 
comment: 
properties:
  contextExtractor:
  correlationIdSettings:
  logUserTrailToDatabase:
  repository:
  sharedSecret: