Skip to main content

Update Privacy Settings

PUT 
https://$CUSTOM-DOMAIN/admin/v1/policies/privacy

Update 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. Variable {{.Lang}} can be set to have different links based on the language.

Request​

Body

required

    tosLink string
    privacyLink string
    helpLink string
    supportEmail string

    help / support email address.

    docsLink string
    customLink string

    Link to an external resource that will be available to users in the console.

    customLinkText string

    The button text that would be shown in console pointing to custom link.

Responses​

default privacy policy updated

Schema

    details

    object

    sequence uint64

    on 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-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/policies/privacy' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "tosLink": "https://zitadel.com/docs/legal/terms-of-service",
  "privacyLink": "https://zitadel.com/docs/legal/privacy-policy",
  "helpLink": "https://zitadel.com/docs/manuals/introduction",
  "supportEmail": "support-email@test.com",
  "docsLink": "https://zitadel.com/docs",
  "customLink": "https://external.link",
  "customLinkText": "External"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
Body required
{
  "tosLink": "https://zitadel.com/docs/legal/terms-of-service",
  "privacyLink": "https://zitadel.com/docs/legal/privacy-policy",
  "helpLink": "https://zitadel.com/docs/manuals/introduction",
  "supportEmail": "support-email@test.com",
  "docsLink": "https://zitadel.com/docs",
  "customLink": "https://external.link",
  "customLinkText": "External"
}
ResponseClear

Click the Send API Request button above and see the response here!