Get Default Password Change Message Text
Get the default text of the password-changed message/email that is configured on the instance or as translation files in ZITADEL itself. The message is sent when the password of a user has been changed.
Path Parameters
- language string required
Header Parameters
- x-zitadel-orgid string
The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
customText object
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs totitle stringcustom text for email title
preHeader stringcustom text for email pre-header
subject stringcustom text for email subject
greeting stringcustom text for email greeting
text stringcustom text for email text
buttonText stringcustom text for email button_text
footerText stringcustom text for email footer_text
isDefault boolean
{
"customText": {
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
},
"title": "ZITADEL - Message Title",
"preHeader": "User Message",
"subject": "Message Subject",
"greeting": "Hello {{.FirstName}} {{.LastName}},",
"text": "This is my custom message Text. I can also include some fields, depending on the message type I want to send. {{.FirstName}} {{.LastName}},",
"buttonText": "Call to action",
"footerText": "",
"isDefault": true
}
}
- Schema
- Example (from schema)
Schema
customText object
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs totitle stringcustom text for email title
preHeader stringcustom text for email pre-header
subject stringcustom text for email subject
greeting stringcustom text for email greeting
text stringcustom text for email text
buttonText stringcustom text for email button_text
footerText stringcustom text for email footer_text
isDefault boolean
{
"customText": {
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
},
"title": "ZITADEL - Message Title",
"preHeader": "User Message",
"subject": "Message Subject",
"greeting": "Hello {{.FirstName}} {{.LastName}},",
"text": "This is my custom message Text. I can also include some fields, depending on the message type I want to send. {{.FirstName}} {{.LastName}},",
"buttonText": "Call to action",
"footerText": "",
"isDefault": true
}
}
- Schema
- Example (from schema)
Schema
customText object
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs totitle stringcustom text for email title
preHeader stringcustom text for email pre-header
subject stringcustom text for email subject
greeting stringcustom text for email greeting
text stringcustom text for email text
buttonText stringcustom text for email button_text
footerText stringcustom text for email footer_text
isDefault boolean
{
"customText": {
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
},
"title": "ZITADEL - Message Title",
"preHeader": "User Message",
"subject": "Message Subject",
"greeting": "Hello {{.FirstName}} {{.LastName}},",
"text": "This is my custom message Text. I can also include some fields, depending on the message type I want to send. {{.FirstName}} {{.LastName}},",
"buttonText": "Call to action",
"footerText": "",
"isDefault": true
}
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}