TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-05-01 01:50:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
zitadel/docs/docs/apis/proto/org.md
Fabi 12f128e3c5
docs: api request descriptions (#1637) 
* doc: api descriptions

* doc: management description

* doc: message validation

* doc: api descriptions

* doc: api descriptions

* doc: description

* doc: index images

* doc: design

* colors, colors and more colors

* margin

* fix comment

* doc: api descriptions

* doc: empty response

* doc: api descriptions

* fix comment

Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2021-04-22 12:59:17 +00:00

2.6 KiB
Raw Blame History

title
zitadel/org.proto

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

Messages

Domain

Field Type Description Validation
org_id string -
details zitadel.v1.ObjectDetails -
domain_name string -
is_verified bool -
is_primary bool -
validation_type DomainValidationType -

DomainNameQuery

Field Type Description Validation
name string - string.max_len: 200
method zitadel.v1.TextQueryMethod - enum.defined_only: true

DomainSearchQuery

Field Type Description Validation
oneof query.domain_name_query DomainNameQuery -

Org

Field Type Description Validation
id string -
details zitadel.v1.ObjectDetails -
state OrgState -
name string -
primary_domain string -

OrgDomainQuery

Field Type Description Validation
domain string - string.max_len: 200
method zitadel.v1.TextQueryMethod - enum.defined_only: true

OrgNameQuery

Field Type Description Validation
name string - string.max_len: 200
method zitadel.v1.TextQueryMethod - enum.defined_only: true

OrgQuery

Field Type Description Validation
oneof query.name_query OrgNameQuery -
oneof query.domain_query OrgDomainQuery -

Enums

DomainValidationType

Name Number Description
DOMAIN_VALIDATION_TYPE_UNSPECIFIED 0 -
DOMAIN_VALIDATION_TYPE_HTTP 1 -
DOMAIN_VALIDATION_TYPE_DNS 2 -

OrgFieldName

Name Number Description
ORG_FIELD_NAME_UNSPECIFIED 0 -
ORG_FIELD_NAME_NAME 1 -

OrgState

Name Number Description
ORG_STATE_UNSPECIFIED 0 -
ORG_STATE_ACTIVE 1 -
ORG_STATE_INACTIVE 2 -