Get the legal and support settings

Return the legal settings for the requested context

Query Parameters

ctx.orgId string
ctx.instance boolean

Responses

• 200
• 403
• 404
• default

---

OK

application/json

application/grpc

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
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to
settings object

tosLink string

privacyPolicyLink string

helpLink string

supportEmail string

help / support email address.

resourceOwnerType resource_owner_type returns if the setting is managed on the organization or on the instance

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

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-03-27T06:43:19.588Z",
    "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"
  }
}

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
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to
settings object

tosLink string

privacyPolicyLink string

helpLink string

supportEmail string

help / support email address.

resourceOwnerType resource_owner_type returns if the setting is managed on the organization or on the instance

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

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-03-27T06:43:19.588Z",
    "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"
  }
}

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
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to
settings object

tosLink string

privacyPolicyLink string

helpLink string

supportEmail string

help / support email address.

resourceOwnerType resource_owner_type returns if the setting is managed on the organization or on the instance

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

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-03-27T06:43:19.589Z",
    "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"
  }
}

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

Loading...