Get Privacy Policy

GET 
/policies/privacy

Returns the privacy settings that should be used for the authenticated user. It is set either on an instance or organization level. This policy defines the TOS and terms of service links.

Responses

200

A successful response.

application/json

Schema

Schema

policy

object

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)

tosLink string

privacyLink string

isDefault boolean

helpLink string

supportEmail string

help / support email address.

docsLink string

Link to documentation to be shown in the console.

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.

Example (from schema)

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-22T16:27:04.303Z",
      "changeDate": "2024-11-22T16:27:04.303Z",
      "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"
  }
}

application/grpc

Schema

Schema

policy

object

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)

tosLink string

privacyLink string

isDefault boolean

helpLink string

supportEmail string

help / support email address.

docsLink string

Link to documentation to be shown in the console.

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.

Example (from schema)

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-22T16:27:04.303Z",
      "changeDate": "2024-11-22T16:27:04.303Z",
      "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"
  }
}

application/grpc-web+proto

Schema

Schema

policy

object

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)

tosLink string

privacyLink string

isDefault boolean

helpLink string

supportEmail string

help / support email address.

docsLink string

Link to documentation to be shown in the console.

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.

Example (from schema)

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-22T16:27:04.304Z",
      "changeDate": "2024-11-22T16:27:04.304Z",
      "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"
  }
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

Loading...