Skip to main content

List Secret Generators​

Lists all the configured secret generators. The generators define how a secret should look when generated in ZITADEL. E.g Email verification code, phone verification code, etc.

Request Body required
    query object

    Object unspecific list filters like offset, limit and asc/desc.

    offset uint64
    limit int64

    Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

    asc boolean

    default is descending

    queries object[]
  • Array [
    • typeQuery 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, SECRET_GENERATOR_TYPE_OTP_SMS, SECRET_GENERATOR_TYPE_OTP_EMAIL]

    Default value: SECRET_GENERATOR_TYPE_UNSPECIFIED

  • ]
Responses

A successful response.

Schema
    details object
    totalResult uint64
    processedSequence uint64
    viewTimestamp date-time

    the last time the view got updated

    result object[]
  • Array [
    • 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, SECRET_GENERATOR_TYPE_OTP_SMS, SECRET_GENERATOR_TYPE_OTP_EMAIL]

    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...