Get Default Privacy Settings​
Returns the default privacy settings configured on the instance. The settings specify the terms and services, privacy policy, etc. A registering user has to accept the configured settings.
Header Parameters
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.
Schema
policy object
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
help / support email address.
Link to documentation to be shown in the console.
Link to an external resource that will be available to users in the console.
The button text that would be shown in console pointing to custom link.
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.673Z",
"changeDate": "2024-06-13T06:44:37.673Z",
"resourceOwner": "69629023906488334"
},
"tosLink": "https://zitadel.com/docs/legal/terms-of-service",
"privacyLink": "https://zitadel.com/docs/legal/privacy-policy",
"isDefault": true,
"helpLink": "https://zitadel.com/docs/manuals/introduction",
"supportEmail": "support-email@test.com",
"docsLink": "https://zitadel.com/docs",
"customLink": "https://external.link",
"customLinkText": "External"
}
}
Schema
policy object
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
help / support email address.
Link to documentation to be shown in the console.
Link to an external resource that will be available to users in the console.
The button text that would be shown in console pointing to custom link.
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.673Z",
"changeDate": "2024-06-13T06:44:37.673Z",
"resourceOwner": "69629023906488334"
},
"tosLink": "https://zitadel.com/docs/legal/terms-of-service",
"privacyLink": "https://zitadel.com/docs/legal/privacy-policy",
"isDefault": true,
"helpLink": "https://zitadel.com/docs/manuals/introduction",
"supportEmail": "support-email@test.com",
"docsLink": "https://zitadel.com/docs",
"customLink": "https://external.link",
"customLinkText": "External"
}
}
Schema
policy object
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
help / support email address.
Link to documentation to be shown in the console.
Link to an external resource that will be available to users in the console.
The button text that would be shown in console pointing to custom link.
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.673Z",
"changeDate": "2024-06-13T06:44:37.673Z",
"resourceOwner": "69629023906488334"
},
"tosLink": "https://zitadel.com/docs/legal/terms-of-service",
"privacyLink": "https://zitadel.com/docs/legal/privacy-policy",
"isDefault": true,
"helpLink": "https://zitadel.com/docs/manuals/introduction",
"supportEmail": "support-email@test.com",
"docsLink": "https://zitadel.com/docs",
"customLink": "https://external.link",
"customLinkText": "External"
}
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}