Get Privacy Settings​
Returns the privacy settings configured on the organization. To be able to trigger the correct policy make sure to identify which organization should be requested on the login/register (organization scope). 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.
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-03-27T06:43:21.607Z",
"changeDate": "2024-03-27T06:43:21.607Z",
"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"
}
}
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.
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-03-27T06:43:21.607Z",
"changeDate": "2024-03-27T06:43:21.607Z",
"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"
}
}
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.
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-03-27T06:43:21.608Z",
"changeDate": "2024-03-27T06:43:21.608Z",
"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"
}
}
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"
}
]
}