KongDirectoryRealmValues
objectConfiguration values used when a Kong v3 data plane connects to identity as realm. The directory is used as a realm for regional consumers.
The time in minutes that the Consumer will be cached in memory on a running Gateway if it is
successfully loaded from Konnect.
Default:10
>= 5
If a running Gateway triggers a lookup for a Consumer that cannot be authenticated this realm, a negative_ttl
is set. The Gateway will not try to lookup the Consumer in Konnect for negative_ttl minutes.
A Consumer will be cached for negative_ttl if they do not exist in the Realm, or if the provided credentials
are invalid.
Default:10
>= 5
A list of consumer groups to automatically add to any consumers created within this Realm.
If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
AllowAllControlPlanes
booleanWhen set to true, all control planes within the organization can make authentication requests to this directory.
This overrides the allowed_control_planes list. Defaults to false for security.
Default:false
DirectoryName
stringHuman-readable name of the directory, used to identify the organizational boundary.
A directory name is unique within the organization.
Match pattern:^[a-z0-9-_]+$
>= 1 characters<= 255 characters
DirectoryDescription
stringOptional description providing additional context about the directory’s purpose or usage.
<= 255 characters
CreateDirectoryBody
objectHuman-readable name of the directory, used to identify the organizational boundary.
A directory name is unique within the organization.
Match pattern:^[a-z0-9-_]+$
>= 1 characters<= 255 characters
Optional description providing additional context about the directory’s purpose or usage.
<= 255 characters
List of control plane IDs authorized to make authentication requests to this directory.
Maximum of 32 control planes can be specified. Use allow_all_control_planes for unrestricted access.
Default:[]
>= 0 items<= 32 items
When set to true, all control planes within the organization can make authentication requests to this directory.
This overrides the allowed_control_planes list. Defaults to false for security.
Default:false
The time in seconds that a principal will be cached in memory on a running Gateway if it is
successfully authenticated from this directory. Maximum is 86400 seconds (24 hours).
Default:600
>= 300<= 86400
If a running Gateway triggers a lookup for a principal that cannot be authenticated in this directory,
a negative_ttl_secs is set. The Gateway will not try to look up the principal in Konnect for negative_ttl_secs seconds.
A principal will be cached for negative_ttl_secs if it does not exist in the directory, or if the provided credentials are invalid.
Maximum is 86400 seconds (24 hours).
Default:600
>= 300<= 86400
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}