List Secret Generators

POST 
https://$CUSTOM-DOMAIN/admin/v1/secretgenerators/_search

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

application/json

Bodyrequired

query object

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

offsetuint64

Example: 0

limitint64

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.

Example: 100

ascboolean

default is descending

queries object[]
Array [
typeQuery object
generatorTypestring
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
]

application/grpc

Bodyrequired

query object

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

offsetuint64

Example: 0

limitint64

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.

Example: 100

ascboolean

default is descending

queries object[]
Array [
typeQuery object
generatorTypestring
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
]

application/grpc-web+proto

Bodyrequired

query object

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

offsetuint64

Example: 0

limitint64

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.

Example: 100

ascboolean

default is descending

queries object[]
Array [
typeQuery object
generatorTypestring
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

200

A successful response.

application/json

Schema

Schema

details object

totalResultuint64

Example: 2

processedSequenceuint64

Example: 267831

viewTimestampdate-time

the last time the view got updated

result object[]
Array [
generatorTypestring
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
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334
lengthint64
Example: 6
expirystring
Example: 3600s
includeLowerLettersboolean
includeUpperLettersboolean
includeDigitsboolean
includeSymbolsboolean
]

Example (auto)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-07-29T15:51:28.071Z"
  },
  "result": [
    {
      "generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
      "details": {
        "sequence": "2",
        "creationDate": "2024-07-29T15:51:28.071Z",
        "changeDate": "2024-07-29T15:51:28.071Z",
        "resourceOwner": "69629023906488334"
      },
      "length": 6,
      "expiry": "3600s",
      "includeLowerLetters": true,
      "includeUpperLetters": true,
      "includeDigits": true,
      "includeSymbols": true
    }
  ]
}

application/grpc

Schema

Schema

details object

totalResultuint64

Example: 2

processedSequenceuint64

Example: 267831

viewTimestampdate-time

the last time the view got updated

result object[]
Array [
generatorTypestring
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
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334
lengthint64
Example: 6
expirystring
Example: 3600s
includeLowerLettersboolean
includeUpperLettersboolean
includeDigitsboolean
includeSymbolsboolean
]

Example (auto)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-07-29T15:51:28.071Z"
  },
  "result": [
    {
      "generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
      "details": {
        "sequence": "2",
        "creationDate": "2024-07-29T15:51:28.071Z",
        "changeDate": "2024-07-29T15:51:28.071Z",
        "resourceOwner": "69629023906488334"
      },
      "length": 6,
      "expiry": "3600s",
      "includeLowerLetters": true,
      "includeUpperLetters": true,
      "includeDigits": true,
      "includeSymbols": true
    }
  ]
}

application/grpc-web+proto

Schema

Schema

details object

totalResultuint64

Example: 2

processedSequenceuint64

Example: 267831

viewTimestampdate-time

the last time the view got updated

result object[]
Array [
generatorTypestring
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
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334
lengthint64
Example: 6
expirystring
Example: 3600s
includeLowerLettersboolean
includeUpperLettersboolean
includeDigitsboolean
includeSymbolsboolean
]

Example (auto)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-07-29T15:51:28.071Z"
  },
  "result": [
    {
      "generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
      "details": {
        "sequence": "2",
        "creationDate": "2024-07-29T15:51:28.071Z",
        "changeDate": "2024-07-29T15:51:28.071Z",
        "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

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc-web+proto

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

404

Returned when the resource does not exist.

application/json

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc-web+proto

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

default

An unexpected error response.

application/json

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc-web+proto

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

Authorization: oauth2

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"
    }
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

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

Auth

Bearer Token

Body required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "typeQuery": {
        "generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED"
      }
    }
  ]
}

ResponseClear

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