List Secret Generators​
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.
application/json
application/grpc
application/grpc-web+proto
Request Body required
query object
queries object[]
Request Body required
query object
queries object[]
Request 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": "2024-06-17T09:46:06.396Z"
},
"result": [
{
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
"details": {
"sequence": "2",
"creationDate": "2024-06-17T09:46:06.396Z",
"changeDate": "2024-06-17T09:46:06.396Z",
"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": "2024-06-17T09:46:06.396Z"
},
"result": [
{
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
"details": {
"sequence": "2",
"creationDate": "2024-06-17T09:46:06.396Z",
"changeDate": "2024-06-17T09:46:06.396Z",
"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": "2024-06-17T09:46:06.397Z"
},
"result": [
{
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED",
"details": {
"sequence": "2",
"creationDate": "2024-06-17T09:46:06.397Z",
"changeDate": "2024-06-17T09:46:06.397Z",
"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"
}
]
}
POST /secretgenerators/_search
Authorization
name: OAuth2type: oauth2scopes:openid,urn:zitadel:iam:org:project:id:zitadel:aud
flows: { "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
Request
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/secretgenerators/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"typeQuery": {
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED"
}
}
]
}'
python / requests
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/secretgenerators/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"typeQuery": {
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED"
}
}
]
}'
go / native
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/secretgenerators/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"typeQuery": {
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED"
}
}
]
}'
nodejs / axios
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/secretgenerators/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"typeQuery": {
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED"
}
}
]
}'
ruby / Net::HTTP
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/secretgenerators/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"typeQuery": {
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED"
}
}
]
}'
csharp / RestSharp
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/secretgenerators/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"typeQuery": {
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED"
}
}
]
}'
php / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/secretgenerators/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"typeQuery": {
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED"
}
}
]
}'
java / OkHttp
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/secretgenerators/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"typeQuery": {
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED"
}
}
]
}'
powershell / RestMethod
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/secretgenerators/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"typeQuery": {
"generatorType": "SECRET_GENERATOR_TYPE_UNSPECIFIED"
}
}
]
}'