Technically, a snippet is a YAML IAM configuration file with the type IamSnippet
(instead of the type IamConfig
). A snippet is organized exactly like a normal IAM configuration. Please refer to the YAML configuration format specification for further details on the file format itself.
A snippet can contain any number of plugins or trees thereof. It is up to the author of the snippet how to divide a larger configuration into snippets.
Consider the following example snippet. It contains two simple and independent plugins.
schemaVersion: iam.airlock.com/v1
type: IamSnippet
metadata:
iamVersion: '8.4'
history:
- datetime: 2025-01-31T08:51:39.046Z
author: marc
comment: Snippet Example 1
spec:
- type: TagConfigImpl
id: emailOtpVerifiedTag
properties:
name: EMAIL_OTP_VERIFIED
- type: Alphabet
id: mtanIakAlphabet
displayName: Alphabet for mTAN activation keys
comment: Do not include chars that look alike.
properties:
characters: ABCDEFGHJKLMNPQRSTUVWXYZ23456789
- Main properties of a snippet:
- The snippet has the type
IamSnippet
- It must adhere to the YAML configuration format specification
id
s are not required. However, specify id
s for plugins that need to be referred to when connecting them to the rest of the configuration. See note below.- A snippet must not include dangling references, i.e.,
ref
s referring to plugins that are not part of the snippet. References within the snippet are valid.
Short vs. long plugin type identifiers
Note that the above example contains short plugin types.
In Airlock IAM 8.4, fully-qualified class names are required as type identifiers (like com.airlock.iam.servicecontainer.app.application.configuration.TaskSchedule
).
Short plugin type identifiers are supported as of IAM 8.5.