zitadel/docs/docs/apis/proto/instance.md
Livio Spring a377f2816c
feat: return instance domains on list instances, fix: login policy and avatar url in oidc responses (#3785)
* feat: return instance domains on list instances

* fix: filter login policy idps correctly

* remove debug

* fix: absolute avatar url in oidc responses
2022-06-08 13:46:24 +02:00

3.2 KiB

title
zitadel/instance.proto

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

Messages

Domain

Field Type Description Validation
details zitadel.v1.ObjectDetails -
domain string -
primary bool -
generated bool -

DomainGeneratedQuery

DomainGeneratedQuery is always equals

Field Type Description Validation
generated bool -

DomainPrimaryQuery

DomainPrimaryQuery is always equals

Field Type Description Validation
primary bool -

DomainQuery

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

DomainSearchQuery

Field Type Description Validation
oneof query.domain_query DomainQuery -
oneof query.generated_query DomainGeneratedQuery -
oneof query.primary_query DomainPrimaryQuery -

IdsQuery

IdQuery is always equals

Field Type Description Validation
ids repeated string -

Instance

Field Type Description Validation
id string -
details zitadel.v1.ObjectDetails -
state State -
name string -
version string -
domains repeated Domain -

InstanceDetail

Field Type Description Validation
id string -
details zitadel.v1.ObjectDetails -
state State -
name string -
version string -
domains repeated Domain -

Query

Field Type Description Validation
oneof query.id_query IdsQuery -

Enums

DomainFieldName

Name Number Description
DOMAIN_FIELD_NAME_UNSPECIFIED 0 -
DOMAIN_FIELD_NAME_DOMAIN 1 -
DOMAIN_FIELD_NAME_PRIMARY 2 -
DOMAIN_FIELD_NAME_GENERATED 3 -
DOMAIN_FIELD_NAME_CREATION_DATE 4 -

FieldName

Name Number Description
FIELD_NAME_UNSPECIFIED 0 -
FIELD_NAME_ID 1 -
FIELD_NAME_NAME 2 -
FIELD_NAME_CREATION_DATE 3 -

State

Name Number Description
STATE_UNSPECIFIED 0 -
STATE_CREATING 1 -
STATE_RUNNING 2 -
STATE_STOPPING 3 -
STATE_STOPPED 4 -