Update Secret Generator
Change a specific secret generator configuration by its type (e.g PasswordResetCode). A generator defines how a secret should look when generating in ZITADEL.
Path Parameters
- generatorType string required
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
]
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
- length int64
- expiry string
- includeLowerLetters boolean
- includeUpperLetters boolean
- includeDigits boolean
- includeSymbols boolean
Request Body required
- length int64
- expiry string
- includeLowerLetters boolean
- includeUpperLetters boolean
- includeDigits boolean
- includeSymbols boolean
Request Body required
- length int64
- expiry string
- includeLowerLetters boolean
- includeUpperLetters boolean
- includeDigits boolean
- includeSymbols boolean
Responses
- 200
- 403
- 404
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2023-05-12",
"changeDate": "2023-05-12",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2023-05-12",
"changeDate": "2023-05-12",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2023-05-12",
"changeDate": "2023-05-12",
"resourceOwner": "69629023906488334"
}
}
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"
}
]
}
PUT /secretgenerators/:generatorType
Authorization
type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud
Request
Request
curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/secretgenerators/:generatorType' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"length": 6,
"expiry": "3600s",
"includeLowerLetters": true,
"includeUpperLetters": true,
"includeDigits": true,
"includeSymbols": true
}'
curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/secretgenerators/:generatorType' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"length": 6,
"expiry": "3600s",
"includeLowerLetters": true,
"includeUpperLetters": true,
"includeDigits": true,
"includeSymbols": true
}'
curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/secretgenerators/:generatorType' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"length": 6,
"expiry": "3600s",
"includeLowerLetters": true,
"includeUpperLetters": true,
"includeDigits": true,
"includeSymbols": true
}'
curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/secretgenerators/:generatorType' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"length": 6,
"expiry": "3600s",
"includeLowerLetters": true,
"includeUpperLetters": true,
"includeDigits": true,
"includeSymbols": true
}'
curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/secretgenerators/:generatorType' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"length": 6,
"expiry": "3600s",
"includeLowerLetters": true,
"includeUpperLetters": true,
"includeDigits": true,
"includeSymbols": true
}'
curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/secretgenerators/:generatorType' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"length": 6,
"expiry": "3600s",
"includeLowerLetters": true,
"includeUpperLetters": true,
"includeDigits": true,
"includeSymbols": true
}'
curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/secretgenerators/:generatorType' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"length": 6,
"expiry": "3600s",
"includeLowerLetters": true,
"includeUpperLetters": true,
"includeDigits": true,
"includeSymbols": true
}'