Skip to main content

Update Secret Generator​

Change a specific secret generator configuration 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, SECRET_GENERATOR_TYPE_OTP_SMS, SECRET_GENERATOR_TYPE_OTP_EMAIL]

Request Body required
    length int64
    expiry string
    includeLowerLetters boolean
    includeUpperLetters boolean
    includeDigits boolean
    includeSymbols boolean
Responses

A successful response.

Schema
    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
PUT /secretgenerators/:generatorType

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/admin/v1
Bearer Token
generatorType — path required
Content-Type
Body required
{

  "length": 6,

  "expiry": "3600s",

  "includeLowerLetters": true,

  "includeUpperLetters": true,

  "includeDigits": true,

  "includeSymbols": true

}
Accept
curl / cURL
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/secretgenerators/:generatorType' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "length": 6,
  "expiry": "3600s",
  "includeLowerLetters": true,
  "includeUpperLetters": true,
  "includeDigits": true,
  "includeSymbols": true
}'