Skip to main content

zitadel/instance.proto

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

Messages

Domain

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
domainstring-
primarybool-
generatedbool-

DomainGeneratedQuery

DomainGeneratedQuery is always equals

FieldTypeDescriptionValidation
generatedbool-

DomainPrimaryQuery

DomainPrimaryQuery is always equals

FieldTypeDescriptionValidation
primarybool-

DomainQuery

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

DomainSearchQuery

FieldTypeDescriptionValidation
oneof query.domain_queryDomainQuery-
oneof query.generated_queryDomainGeneratedQuery-
oneof query.primary_queryDomainPrimaryQuery-

IdsQuery

IdQuery is always equals

FieldTypeDescriptionValidation
idsrepeated string-

Instance

FieldTypeDescriptionValidation
idstring-
detailszitadel.v1.ObjectDetails-
stateState-
namestring-
versionstring-
domainsrepeated Domain-

InstanceDetail

FieldTypeDescriptionValidation
idstring-
detailszitadel.v1.ObjectDetails-
stateState-
namestring-
versionstring-
domainsrepeated Domain-

Query

FieldTypeDescriptionValidation
oneof query.id_queryIdsQuery-

Enums

DomainFieldName

NameNumberDescription
DOMAIN_FIELD_NAME_UNSPECIFIED0-
DOMAIN_FIELD_NAME_DOMAIN1-
DOMAIN_FIELD_NAME_PRIMARY2-
DOMAIN_FIELD_NAME_GENERATED3-
DOMAIN_FIELD_NAME_CREATION_DATE4-

FieldName

NameNumberDescription
FIELD_NAME_UNSPECIFIED0-
FIELD_NAME_ID1-
FIELD_NAME_NAME2-
FIELD_NAME_CREATION_DATE3-

State

NameNumberDescription
STATE_UNSPECIFIED0-
STATE_CREATING1-
STATE_RUNNING2-
STATE_STOPPING3-
STATE_STOPPED4-