List Secret Generators
POST/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
Array [
]
query
object
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
queries
object[]
typeQuery
object
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
Body
required
Array [
]
query
object
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
queries
object[]
typeQuery
object
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
Body
required
Array [
]
query
object
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
queries
object[]
typeQuery
object
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
- 403
- 404
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
result
object[]
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
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-12-06T11:34:49.506Z"
},
"result": [
{
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
"details": {
"sequence": "2",
"creationDate": "2024-12-06T11:34:49.507Z",
"changeDate": "2024-12-06T11:34:49.507Z",
"resourceOwner": "69629023906488334"
},
"length": 6,
"expiry": "3600s",
"includeLowerLetters": true,
"includeUpperLetters": true,
"includeDigits": true,
"includeSymbols": true
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
result
object[]
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
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-12-06T11:34:49.509Z"
},
"result": [
{
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
"details": {
"sequence": "2",
"creationDate": "2024-12-06T11:34:49.509Z",
"changeDate": "2024-12-06T11:34:49.509Z",
"resourceOwner": "69629023906488334"
},
"length": 6,
"expiry": "3600s",
"includeLowerLetters": true,
"includeUpperLetters": true,
"includeDigits": true,
"includeSymbols": true
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
result
object[]
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
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-12-06T11:34:49.509Z"
},
"result": [
{
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
"details": {
"sequence": "2",
"creationDate": "2024-12-06T11:34:49.509Z",
"changeDate": "2024-12-06T11:34:49.509Z",
"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
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
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
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
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
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}