Get Organization By Domain
GET/global/orgs/_by_domain
Search an organization by the domain, overall organizations. The domain must match exactly.
Request​
Query Parameters
Responses​
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
org
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [ORG_STATE_UNSPECIFIED
, ORG_STATE_ACTIVE
, ORG_STATE_INACTIVE
, ORG_STATE_REMOVED
]
Default value: ORG_STATE_UNSPECIFIED
current state of the organization
{
"org": {
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-11-15T21:46:16.083Z",
"changeDate": "2024-11-15T21:46:16.083Z",
"resourceOwner": "69629023906488334"
},
"state": "ORG_STATE_UNSPECIFIED",
"name": "ZITADEL",
"primaryDomain": "zitadel.cloud"
}
}
- Schema
- Example (from schema)
Schema
org
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [ORG_STATE_UNSPECIFIED
, ORG_STATE_ACTIVE
, ORG_STATE_INACTIVE
, ORG_STATE_REMOVED
]
Default value: ORG_STATE_UNSPECIFIED
current state of the organization
{
"org": {
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-11-15T21:46:16.083Z",
"changeDate": "2024-11-15T21:46:16.083Z",
"resourceOwner": "69629023906488334"
},
"state": "ORG_STATE_UNSPECIFIED",
"name": "ZITADEL",
"primaryDomain": "zitadel.cloud"
}
}
- Schema
- Example (from schema)
Schema
org
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [ORG_STATE_UNSPECIFIED
, ORG_STATE_ACTIVE
, ORG_STATE_INACTIVE
, ORG_STATE_REMOVED
]
Default value: ORG_STATE_UNSPECIFIED
current state of the organization
{
"org": {
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-11-15T21:46:16.084Z",
"changeDate": "2024-11-15T21:46:16.084Z",
"resourceOwner": "69629023906488334"
},
"state": "ORG_STATE_UNSPECIFIED",
"name": "ZITADEL",
"primaryDomain": "zitadel.cloud"
}
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}