Returns all stored read models of ZITADEL

views are used for search optimisation and optimise request latencies they represent the delta of the event happend on the objects

Returns all stored read models of ZITADEL views are used for search optimisation and optimise request latencies they represent the delta of the event happend on the objects

application/json

Request Body required

• object

application/grpc

Request Body required

• object

application/grpc-web+proto

Request Body required

• object

Responses

• 200
• 403
• 404
• default

---

Views for query operations

application/json

• Schema
• Example (from schema)

---

Schema

• result object[]

  Array [

  database string

  viewName string

  processedSequence uint64

  eventTimestamp date-time

  The timestamp the event occured

  lastSuccessfulSpoolerRun date-time

  The timestamp the event occured

  instance string

  ]

{
  "result": [
    {
      "database": "adminapi",
      "viewName": "iam_members",
      "processedSequence": "9823758",
      "eventTimestamp": "2019-04-01T08:45:00.000000Z",
      "lastSuccessfulSpoolerRun": "2023-05-12",
      "instance": "840498034930840"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• result object[]

  Array [

  database string

  viewName string

  processedSequence uint64

  eventTimestamp date-time

  The timestamp the event occured

  lastSuccessfulSpoolerRun date-time

  The timestamp the event occured

  instance string

  ]

{
  "result": [
    {
      "database": "adminapi",
      "viewName": "iam_members",
      "processedSequence": "9823758",
      "eventTimestamp": "2019-04-01T08:45:00.000000Z",
      "lastSuccessfulSpoolerRun": "2023-05-12",
      "instance": "840498034930840"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• result object[]

  Array [

  database string

  viewName string

  processedSequence uint64

  eventTimestamp date-time

  The timestamp the event occured

  lastSuccessfulSpoolerRun date-time

  The timestamp the event occured

  instance string

  ]

{
  "result": [
    {
      "database": "adminapi",
      "viewName": "iam_members",
      "processedSequence": "9823758",
      "eventTimestamp": "2019-04-01T08:45:00.000000Z",
      "lastSuccessfulSpoolerRun": "2023-05-12",
      "instance": "840498034930840"
    }
  ]
}

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

POST /views/_search

Request

Base URL

https://$ZITADEL_DOMAIN/system/v1

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/views/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{}'

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/views/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{}'

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/views/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{}'

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/views/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{}'

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/views/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{}'

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/views/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{}'

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/views/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{}'