Update Privacy Settings

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.

application/json

Request Body required

• tosLink string
• privacyLink string
• helpLink string
• supportEmail string

  help / support email address.

application/grpc

Request Body required

• tosLink string
• privacyLink string
• helpLink string
• supportEmail string

  help / support email address.

application/grpc-web+proto

Request Body required

• tosLink string
• privacyLink string
• helpLink string
• supportEmail string

  help / support email address.

Responses

• 200
• 400
• 403
• 404
• default

---

default privacy policy updated

application/json

• Schema
• Example (from schema)

---

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

{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc

• Schema
• Example (from schema)

---

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

{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

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

{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  }
}

invalid argument

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the user does not have permission to access the resource.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the resource does not exist.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

PUT /policies/privacy

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL

https://$ZITADEL_DOMAIN/admin/v1

Bearer Token

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

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"
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl -L -X PUT 'https://$ZITADEL_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"
}'

curl -L -X PUT 'https://$ZITADEL_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"
}'

curl -L -X PUT 'https://$ZITADEL_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"
}'

curl -L -X PUT 'https://$ZITADEL_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"
}'

curl -L -X PUT 'https://$ZITADEL_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"
}'

curl -L -X PUT 'https://$ZITADEL_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"
}'

curl -L -X PUT 'https://$ZITADEL_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"
}'