List Secret Generators
POSThttps://$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
- application/grpc
- application/grpc-web+proto
Body
required
query
object
queries
object[]
Body
required
query
object
queries
object[]
Body
required
query
object
queries
object[]
Responses​
- 200
- 403
- 404
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object
result
object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2025-03-31T10:57:52.445Z"
},
"result": [
{
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
"details": {
"sequence": "2",
"creationDate": "2025-03-31T10:57:52.445Z",
"changeDate": "2025-03-31T10:57:52.445Z",
"resourceOwner": "69629023906488334"
},
"length": 6,
"expiry": "3600s",
"includeLowerLetters": true,
"includeUpperLetters": true,
"includeDigits": true,
"includeSymbols": true
}
]
}
- Schema
- Example (from schema)
Schema
details
object
result
object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2025-03-31T10:57:52.446Z"
},
"result": [
{
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
"details": {
"sequence": "2",
"creationDate": "2025-03-31T10:57:52.446Z",
"changeDate": "2025-03-31T10:57:52.446Z",
"resourceOwner": "69629023906488334"
},
"length": 6,
"expiry": "3600s",
"includeLowerLetters": true,
"includeUpperLetters": true,
"includeDigits": true,
"includeSymbols": true
}
]
}
- Schema
- Example (from schema)
Schema
details
object
result
object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2025-03-31T10:57:52.446Z"
},
"result": [
{
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
"details": {
"sequence": "2",
"creationDate": "2025-03-31T10:57:52.446Z",
"changeDate": "2025-03-31T10:57:52.446Z",
"resourceOwner": "69629023906488334"
},
"length": 6,
"expiry": "3600s",
"includeLowerLetters": true,
"includeUpperLetters": true,
"includeDigits": true,
"includeSymbols": true
}
]
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"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/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"typeQuery": {
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED"
}
}
]
}'
ResponseClear