Get the legal and support settings​
Return the legal settings for the requested context
Query Parameters
- 200
- 403
- 404
- default
OK
Schema
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
settings object
help / support email address.
Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED
, RESOURCE_OWNER_TYPE_INSTANCE
, RESOURCE_OWNER_TYPE_ORG
]
Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED
resource_owner_type returns if the setting is managed on the organization or on the instance
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.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.930Z",
"resourceOwner": "69629023906488334"
},
"settings": {
"tosLink": "https://zitadel.com/docs/legal/terms-of-service",
"privacyPolicyLink": "https://zitadel.com/docs/legal/privacy-policy",
"helpLink": "https://zitadel.com/docs/manuals/introduction",
"supportEmail": "support-email@test.com",
"resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED",
"docsLink": "https://zitadel.com/docs",
"customLink": "https://external.link",
"customLinkText": "External"
}
}
Schema
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
settings object
help / support email address.
Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED
, RESOURCE_OWNER_TYPE_INSTANCE
, RESOURCE_OWNER_TYPE_ORG
]
Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED
resource_owner_type returns if the setting is managed on the organization or on the instance
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.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.930Z",
"resourceOwner": "69629023906488334"
},
"settings": {
"tosLink": "https://zitadel.com/docs/legal/terms-of-service",
"privacyPolicyLink": "https://zitadel.com/docs/legal/privacy-policy",
"helpLink": "https://zitadel.com/docs/manuals/introduction",
"supportEmail": "support-email@test.com",
"resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED",
"docsLink": "https://zitadel.com/docs",
"customLink": "https://external.link",
"customLinkText": "External"
}
}
Schema
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
settings object
help / support email address.
Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED
, RESOURCE_OWNER_TYPE_INSTANCE
, RESOURCE_OWNER_TYPE_ORG
]
Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED
resource_owner_type returns if the setting is managed on the organization or on the instance
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.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.930Z",
"resourceOwner": "69629023906488334"
},
"settings": {
"tosLink": "https://zitadel.com/docs/legal/terms-of-service",
"privacyPolicyLink": "https://zitadel.com/docs/legal/privacy-policy",
"helpLink": "https://zitadel.com/docs/manuals/introduction",
"supportEmail": "support-email@test.com",
"resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED",
"docsLink": "https://zitadel.com/docs",
"customLink": "https://external.link",
"customLinkText": "External"
}
}
Returned when the user does not have permission to access the resource.
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"
}
]
}
Returned when the resource does not exist.
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"
}
]
}
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"
}
]
}