zitadel/docs/docs/apis/proto/idp.md at ff9af1704f3cb04332eb9f44fc42a23bc149e70e

mirror of https://github.com/andwati/zitadel.git synced 2026-10-26 01:02:16 +00:00

Files

T

FabiandGitHub ff9af1704f feat: Extend oidc idp with oauth endpoints (#1980 )

* feat: add oauth attributes to oidc idp configuration

* feat: return idpconfig id on create idp

* feat: tests

* feat: descriptions

* feat: docs

* feat: tests

2021-07-06 14:39:48 +00:00

3.4 KiB

Raw Blame History

title

title
zitadel/idp.proto

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

Messages

IDP

Field	Type	Description
id	string	-
details	zitadel.v1.ObjectDetails	-
state	IDPState	-
name	string	-
styling_type	IDPStylingType	-
owner	IDPOwnerType	-
oneof config.oidc_config	OIDCConfig	-

IDPIDQuery

Field	Type	Description	Validation
id	string	-	string.max_len: 200

IDPLoginPolicyLink

Field	Type	Description
idp_id	string	-
idp_name	string	-
idp_type	IDPType	-

IDPNameQuery

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

IDPOwnerTypeQuery

Field	Type	Description	Validation
owner_type	IDPOwnerType	-	enum.defined_only: true

IDPUserLink

Field	Type	Description
user_id	string	-
idp_id	string	-
idp_name	string	-
provided_user_id	string	-
provided_user_name	string	-
idp_type	IDPType	-

OIDCConfig

Field	Type	Description	Validation
client_id	string	-
issuer	string	-
scopes	repeated string	-
display_name_mapping	OIDCMappingField	-
username_mapping	OIDCMappingField	-
authorization_endpoint	string	-	string.max_len: 500
token_endpoint	string	-	string.max_len: 500

Enums

IDPFieldName

Name	Number	Description
IDP_FIELD_NAME_UNSPECIFIED	0	-
IDP_FIELD_NAME_NAME	1	-

IDPOwnerType

the owner of the identity provider.

Name	Number	Description
IDP_OWNER_TYPE_UNSPECIFIED	0	-
IDP_OWNER_TYPE_SYSTEM	1	system is managed by the ZITADEL administrators
IDP_OWNER_TYPE_ORG	2	org is managed by de organisation administrators

IDPState

Name	Number	Description
IDP_STATE_UNSPECIFIED	0	-
IDP_STATE_ACTIVE	1	-
IDP_STATE_INACTIVE	2	-

IDPStylingType

Name	Number	Description
STYLING_TYPE_UNSPECIFIED	0	-
STYLING_TYPE_GOOGLE	1	-

IDPType

authorization framework of the identity provider

Name	Number	Description
IDP_TYPE_UNSPECIFIED	0	-
IDP_TYPE_OIDC	1	PLANNED: IDP_TYPE_SAML

OIDCMappingField

Name	Number	Description
OIDC_MAPPING_FIELD_UNSPECIFIED	0	-
OIDC_MAPPING_FIELD_PREFERRED_USERNAME	1	-
OIDC_MAPPING_FIELD_EMAIL	2	-

3.4 KiB Raw Blame History