ResetPasswordRequest

object

The request schema for the reset password endpoint.

* Additional properties are NOT allowed.
passwordstring(password)required

Example:<!N0taP@$$w0rd!>

tokenstring(uuid)required

Example:c8efd006-d8e1-4743-b91b-f163b9eae06a

Example

VerifyEmailRequest

object

The request schema for the verify email endpoint.

* Additional properties are NOT allowed.
tokenstring(uuid)required

Example:c8efd006-d8e1-4743-b91b-f163b9eae06a

Example

VerifyEmailResponse

object

The response schema for the verify email endpoint.

* Additional properties are NOT allowed.
emailstring(email)read-only

Example:developer@example.com

tokenstring(uuid)read-only

Example:c8efd006-d8e1-4743-b91b-f163b9eae06a

Example

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

InvalidRules

string

invalid parameters rules

Allowed values:requiredis_arrayis_base64is_booleanis_date_timeis_integeris_nullis_numberis_objectis_stringis_uuidis_fqdnis_arnunknown_propertymissing_referenceis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_regiontype