Get Secret Generator

GET 
https://$CUSTOM-DOMAIN/admin/v1/secretgenerators/:generatorType

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

Request

Path Parameters

generatorType stringrequired

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]

Responses

200

A successful response.

application/json

Schema

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, 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 (string)

length int64

expiry string

includeLowerLetters boolean

includeUpperLetters boolean

includeDigits boolean

includeSymbols boolean

Example (from schema)

{
  "secretGenerator": {
    "generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
    "details": {
      "sequence": "2",
      "creationDate": "2025-03-25T07:19:31.359Z",
      "changeDate": "2025-03-25T07:19:31.359Z",
      "resourceOwner": "69629023906488334"
    },
    "length": 6,
    "expiry": "3600s",
    "includeLowerLetters": true,
    "includeUpperLetters": true,
    "includeDigits": true,
    "includeSymbols": true
  }
}

application/grpc

Schema

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, 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 (string)

length int64

expiry string

includeLowerLetters boolean

includeUpperLetters boolean

includeDigits boolean

includeSymbols boolean

Example (from schema)

{
  "secretGenerator": {
    "generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
    "details": {
      "sequence": "2",
      "creationDate": "2025-03-25T07:19:31.359Z",
      "changeDate": "2025-03-25T07:19:31.359Z",
      "resourceOwner": "69629023906488334"
    },
    "length": 6,
    "expiry": "3600s",
    "includeLowerLetters": true,
    "includeUpperLetters": true,
    "includeDigits": true,
    "includeSymbols": true
  }
}

application/grpc-web+proto

Schema

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, 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 (string)

length int64

expiry string

includeLowerLetters boolean

includeUpperLetters boolean

includeDigits boolean

includeSymbols boolean

Example (from schema)

{
  "secretGenerator": {
    "generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
    "details": {
      "sequence": "2",
      "creationDate": "2025-03-25T07:19:31.360Z",
      "changeDate": "2025-03-25T07:19:31.360Z",
      "resourceOwner": "69629023906488334"
    },
    "length": 6,
    "expiry": "3600s",
    "includeLowerLetters": true,
    "includeUpperLetters": true,
    "includeDigits": true,
    "includeSymbols": true
  }
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://$CUSTOM-DOMAIN/admin/v1/secretgenerators/:generatorType' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN/admin/v1

Auth

Bearer Token

Parameters

generatorType — pathrequired

---SECRET_GENERATOR_TYPE_UNSPECIFIEDSECRET_GENERATOR_TYPE_INIT_CODESECRET_GENERATOR_TYPE_VERIFY_EMAIL_CODESECRET_GENERATOR_TYPE_VERIFY_PHONE_CODESECRET_GENERATOR_TYPE_PASSWORD_RESET_CODESECRET_GENERATOR_TYPE_PASSWORDLESS_INIT_CODESECRET_GENERATOR_TYPE_APP_SECRETSECRET_GENERATOR_TYPE_OTP_SMSSECRET_GENERATOR_TYPE_OTP_EMAIL

ResponseClear

Click the Send API Request button above and see the response here!