Get Privacy Settings
GET/policies/privacy
Returns the privacy settings configured on the instance. It affects all organizations, that do not have a custom setting configured. The settings specify the terms and services, privacy policy, etc. A registering user has to accept the configured settings.
Responses​
- 200
- 403
- 404
- default
default privacy policy
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
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-12-23T07:03:29.969Z",
"changeDate": "2024-12-23T07:03:29.969Z",
"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
- Example (from schema)
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-12-23T07:03:29.970Z",
"changeDate": "2024-12-23T07:03:29.970Z",
"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
- Example (from schema)
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-12-23T07:03:29.971Z",
"changeDate": "2024-12-23T07:03:29.971Z",
"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"
}
}
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"
}
]
}