Get Privacy Settings

Returns 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.

Responses

• 200
• 403
• 404
• default

---

default privacy policy

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from 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

tosLink string

privacyLink string

isDefault boolean

helpLink string

supportEmail string

help / support email address.

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-03-27T10:05:52.763Z",
      "changeDate": "2024-03-27T10:05:52.763Z",
      "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

Example (from 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

tosLink string

privacyLink string

isDefault boolean

helpLink string

supportEmail string

help / support email address.

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-03-27T10:05:52.763Z",
      "changeDate": "2024-03-27T10:05:52.763Z",
      "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

Example (from 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

tosLink string

privacyLink string

isDefault boolean

helpLink string

supportEmail string

help / support email address.

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-03-27T10:05:52.763Z",
      "changeDate": "2024-03-27T10:05:52.763Z",
      "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"
  }
}

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

application/json

application/grpc

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

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

application/grpc

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

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

application/grpc

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

GET /policies/privacy

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL

https://$CUSTOM-DOMAIN/admin/v1

Bearer Token

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/policies/privacy' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

python / requests

curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/policies/privacy' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

go / native

curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/policies/privacy' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

nodejs / axios

curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/policies/privacy' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

ruby / Net::HTTP

curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/policies/privacy' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

csharp / RestSharp

curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/policies/privacy' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

php / cURL

curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/policies/privacy' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

java / OkHttp

curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/policies/privacy' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

powershell / RestMethod

curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/policies/privacy' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'