Skip to main content

zitadel/idp.proto

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

Messages

IDP

FieldTypeDescriptionValidation
idstring-
detailszitadel.v1.ObjectDetails-
stateIDPState-
namestring-
styling_typeIDPStylingType-
ownerIDPOwnerType-
oneof config.oidc_configOIDCConfig-
oneof config.jwt_configJWTConfig-
auto_registerbool-

IDPIDQuery

FieldTypeDescriptionValidation
idstring-string.max_len: 200
FieldTypeDescriptionValidation
idp_idstring-
idp_namestring-
idp_typeIDPType-

IDPNameQuery

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

IDPOwnerTypeQuery

FieldTypeDescriptionValidation
owner_typeIDPOwnerType-enum.defined_only: true
FieldTypeDescriptionValidation
user_idstring-
idp_idstring-
idp_namestring-
provided_user_idstring-
provided_user_namestring-
idp_typeIDPType-

JWTConfig

FieldTypeDescriptionValidation
jwt_endpointstring-string.min_len: 1
string.max_len: 200
issuerstring-string.min_len: 1
string.max_len: 200
keys_endpointstring-string.min_len: 1
string.max_len: 200
header_namestring-string.min_len: 1
string.max_len: 200

OIDCConfig

FieldTypeDescriptionValidation
client_idstring-
issuerstring-
scopesrepeated string-
display_name_mappingOIDCMappingField-
username_mappingOIDCMappingField-

Enums

IDPFieldName

NameNumberDescription
IDP_FIELD_NAME_UNSPECIFIED0-
IDP_FIELD_NAME_NAME1-

IDPOwnerType

the owner of the identity provider.

NameNumberDescription
IDP_OWNER_TYPE_UNSPECIFIED0-
IDP_OWNER_TYPE_SYSTEM1system is managed by the ZITADEL administrators
IDP_OWNER_TYPE_ORG2org is managed by de organisation administrators

IDPState

NameNumberDescription
IDP_STATE_UNSPECIFIED0-
IDP_STATE_ACTIVE1-
IDP_STATE_INACTIVE2-

IDPStylingType

NameNumberDescription
STYLING_TYPE_UNSPECIFIED0-
STYLING_TYPE_GOOGLE1-

IDPType

authorization framework of the identity provider

NameNumberDescription
IDP_TYPE_UNSPECIFIED0-
IDP_TYPE_OIDC1-
IDP_TYPE_JWT3PLANNED: IDP_TYPE_SAML

OIDCMappingField

NameNumberDescription
OIDC_MAPPING_FIELD_UNSPECIFIED0-
OIDC_MAPPING_FIELD_PREFERRED_USERNAME1-
OIDC_MAPPING_FIELD_EMAIL2-