ZITADEL Docs
APIsCore ResourcesV1Instance Objects

GetSecretGenerator

GET
/secretgenerators/{generator_type}

Path Parameters

generator_type*string
Value in"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"

Response Body

application/json

application/json

curl -X GET "https://loading/secretgenerators/SECRET_GENERATOR_TYPE_UNSPECIFIED"
{
  "secretGenerator": {
    "generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
    "details": {
      "sequence": 0,
      "creationDate": "1s",
      "changeDate": "1s",
      "resourceOwner": "string"
    },
    "length": 0,
    "expiry": "string",
    "includeLowerLetters": true,
    "includeUpperLetters": true,
    "includeDigits": true,
    "includeSymbols": true
  }
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?

GetRestrictions

Previous Page

GetSecurityPolicy

Next Page