Get Organization By Domain

Search an organization by the domain, overall organizations. The domain must match exactly.

Query Parameters

• domain string required

Responses

• 200
• default

---

A successful response.

application/json

• Schema
• Example (from schema)

---

Schema

• org object

  id string

  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

  state string

  Possible values: [ORG_STATE_UNSPECIFIED, ORG_STATE_ACTIVE, ORG_STATE_INACTIVE, ORG_STATE_REMOVED]

  Default value: ORG_STATE_UNSPECIFIED

  current state of the organization

  name string

  primaryDomain string

{
  "org": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-02",
      "changeDate": "2023-05-02",
      "resourceOwner": "69629023906488334"
    },
    "state": "ORG_STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "primaryDomain": "zitadel.cloud"
  }
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• org object

  id string

  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

  state string

  Possible values: [ORG_STATE_UNSPECIFIED, ORG_STATE_ACTIVE, ORG_STATE_INACTIVE, ORG_STATE_REMOVED]

  Default value: ORG_STATE_UNSPECIFIED

  current state of the organization

  name string

  primaryDomain string

{
  "org": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-02",
      "changeDate": "2023-05-02",
      "resourceOwner": "69629023906488334"
    },
    "state": "ORG_STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "primaryDomain": "zitadel.cloud"
  }
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• org object

  id string

  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

  state string

  Possible values: [ORG_STATE_UNSPECIFIED, ORG_STATE_ACTIVE, ORG_STATE_INACTIVE, ORG_STATE_REMOVED]

  Default value: ORG_STATE_UNSPECIFIED

  current state of the organization

  name string

  primaryDomain string

{
  "org": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-02",
      "changeDate": "2023-05-02",
      "resourceOwner": "69629023906488334"
    },
    "state": "ORG_STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "primaryDomain": "zitadel.cloud"
  }
}

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

Loading...