ConflictError
The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.
Example:409
A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.
Example:Conflict
The error type.
Example:https://httpstatuses.com/409
Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.
Example:kong:trace:1234567890
A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.
Example:Conflict
NotFoundError
The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.
Example:404
A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.
Example:Not Found
The error type.
Example:https://httpstatuses.com/404
Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.
Example:kong:trace:1234567890
A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.
Example:Not found
RealmTTL
integerThe 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
NegativeTTL
integerIf 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
RealmConsumerGroups
arrayA 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.