Skip to main content

zitadel/org.proto

This document reflects the state from API 1.0 (available from 20.04.2021)

Messages​

Domain​

FieldTypeDescriptionValidation
org_idstring-
detailszitadel.v1.ObjectDetails-
domain_namestring-
is_verifiedbool-
is_primarybool-
validation_typeDomainValidationType-

DomainNameQuery​

FieldTypeDescriptionValidation
namestring-string.max_len: 200
methodzitadel.v1.TextQueryMethod-enum.defined_only: true

DomainSearchQuery​

FieldTypeDescriptionValidation
oneof query.domain_name_queryDomainNameQuery-

Org​

FieldTypeDescriptionValidation
idstring-
detailszitadel.v1.ObjectDetails-
stateOrgState-
namestring-
primary_domainstring-

OrgDomainQuery​

FieldTypeDescriptionValidation
domainstring-string.max_len: 200
methodzitadel.v1.TextQueryMethod-enum.defined_only: true

OrgNameQuery​

FieldTypeDescriptionValidation
namestring-string.max_len: 200
methodzitadel.v1.TextQueryMethod-enum.defined_only: true

OrgQuery​

FieldTypeDescriptionValidation
oneof query.name_queryOrgNameQuery-
oneof query.domain_queryOrgDomainQuery-

Enums​

DomainValidationType​

NameNumberDescription
DOMAIN_VALIDATION_TYPE_UNSPECIFIED0-
DOMAIN_VALIDATION_TYPE_HTTP1-
DOMAIN_VALIDATION_TYPE_DNS2-

OrgFieldName​

NameNumberDescription
ORG_FIELD_NAME_UNSPECIFIED0-
ORG_FIELD_NAME_NAME1-

OrgState​

NameNumberDescription
ORG_STATE_UNSPECIFIED0-
ORG_STATE_ACTIVE1-
ORG_STATE_INACTIVE2-