Skip to main content

zitadel/app.proto

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

Messages

APIConfig

FieldTypeDescriptionValidation
client_idstring-
client_secretstring-
auth_method_typeAPIAuthMethodType-

App

FieldTypeDescriptionValidation
idstring-
detailszitadel.v1.ObjectDetails-
stateAppState-
namestring-
oneof config.oidc_configOIDCConfig-
oneof config.api_configAPIConfig-

AppNameQuery

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

AppQuery

FieldTypeDescriptionValidation
oneof query.name_queryAppNameQuery-

OIDCConfig

FieldTypeDescriptionValidation
redirect_urisrepeated string-
response_typesrepeated OIDCResponseType-
grant_typesrepeated OIDCGrantType-
app_typeOIDCAppType-
client_idstring-
client_secretstring-
auth_method_typeOIDCAuthMethodType-
post_logout_redirect_urisrepeated string-
versionOIDCVersion-
none_compliantbool-
compliance_problemsrepeated zitadel.v1.LocalizedMessage-
dev_modebool-
access_token_typeOIDCTokenType-
access_token_role_assertionbool-
id_token_role_assertionbool-
id_token_userinfo_assertionbool-
clock_skewgoogle.protobuf.Duration-
additional_originsrepeated string-
allowed_originsrepeated string-

Enums

APIAuthMethodType

NameNumberDescription
API_AUTH_METHOD_TYPE_BASIC0-
API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT1-

AppState

NameNumberDescription
APP_STATE_UNSPECIFIED0-
APP_STATE_ACTIVE1-
APP_STATE_INACTIVE2-

OIDCAppType

NameNumberDescription
OIDC_APP_TYPE_WEB0-
OIDC_APP_TYPE_USER_AGENT1-
OIDC_APP_TYPE_NATIVE2-

OIDCAuthMethodType

NameNumberDescription
OIDC_AUTH_METHOD_TYPE_BASIC0-
OIDC_AUTH_METHOD_TYPE_POST1-
OIDC_AUTH_METHOD_TYPE_NONE2-
OIDC_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT3-

OIDCGrantType

NameNumberDescription
OIDC_GRANT_TYPE_AUTHORIZATION_CODE0-
OIDC_GRANT_TYPE_IMPLICIT1-
OIDC_GRANT_TYPE_REFRESH_TOKEN2-

OIDCResponseType

NameNumberDescription
OIDC_RESPONSE_TYPE_CODE0-
OIDC_RESPONSE_TYPE_ID_TOKEN1-
OIDC_RESPONSE_TYPE_ID_TOKEN_TOKEN2-

OIDCTokenType

NameNumberDescription
OIDC_TOKEN_TYPE_BEARER0-
OIDC_TOKEN_TYPE_JWT1-

OIDCVersion

NameNumberDescription
OIDC_VERSION_1_00-