Skip to main content

Get Secret Generator​

Get a specific secret generator by its type (e.g PasswordResetCode). A generator defines how a secret should look when generating in ZITADEL.

Path Parameters
  • generatorType string required

    Possible values: [SECRET_GENERATOR_TYPE_UNSPECIFIED, SECRET_GENERATOR_TYPE_INIT_CODE, SECRET_GENERATOR_TYPE_VERIFY_EMAIL_CODE, SECRET_GENERATOR_TYPE_VERIFY_PHONE_CODE, SECRET_GENERATOR_TYPE_PASSWORD_RESET_CODE, SECRET_GENERATOR_TYPE_PASSWORDLESS_INIT_CODE, SECRET_GENERATOR_TYPE_APP_SECRET]

Responses

A successful response.

Schema
  • secretGenerator object
  • generatorType string

    Possible values: [SECRET_GENERATOR_TYPE_UNSPECIFIED, SECRET_GENERATOR_TYPE_INIT_CODE, SECRET_GENERATOR_TYPE_VERIFY_EMAIL_CODE, SECRET_GENERATOR_TYPE_VERIFY_PHONE_CODE, SECRET_GENERATOR_TYPE_PASSWORD_RESET_CODE, SECRET_GENERATOR_TYPE_PASSWORDLESS_INIT_CODE, SECRET_GENERATOR_TYPE_APP_SECRET]

    Default value: SECRET_GENERATOR_TYPE_UNSPECIFIED

  • details object
  • sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

  • changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

  • resourceOwner resource_owner is the organization an object belongs to
  • length int64
  • expiry string
  • includeLowerLetters boolean
  • includeUpperLetters boolean
  • includeDigits boolean
  • includeSymbols boolean
Loading...