AuthenticateBody

object
secretstringrequired
metaobject

Default:{}

Example

AuthenticateResponseBody

object
idstringrequired
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

usernamestringrequired
custom_idstringrequired
typestringrequired
tagsarray[string]requiredunique-items
username_lowerstringrequired
ttlintegerrequired
negative_ttlintegerrequired
consumer_group_namesarray[string]required
credentialobject
Show Child Parameters
metaobjectrequired
Example

AuthenticateCredential

object
idstringrequired
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

tagsarray[string]requiredunique-items
Example

ConsumerGroups

array

A list of consumer groups that the Consumer is in.
If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.

Error

object

standard error

statusintegerrequiredread-only

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.

titlestringrequiredread-only

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.

typestringread-only

The error type.

instancestringrequiredread-only

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.

detailstringrequiredread-only

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