Skip to main content

zitadel/user.proto

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

Messages

AuthFactor

FieldTypeDescriptionValidation
stateAuthFactorState-
oneof type.otpAuthFactorOTP-
oneof type.u2fAuthFactorU2F-

AuthFactorOTP

AuthFactorU2F

FieldTypeDescriptionValidation
idstring-
namestring-

DisplayNameQuery

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

Email

FieldTypeDescriptionValidation
emailstring-
is_email_verifiedbool-

EmailQuery

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

FirstNameQuery

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

Human

FieldTypeDescriptionValidation
profileProfile-
emailEmail-
phonePhone-

LastNameQuery

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

Machine

FieldTypeDescriptionValidation
namestring-
descriptionstring-

Membership

FieldTypeDescriptionValidation
user_idstring-
detailszitadel.v1.ObjectDetails-
rolesrepeated string-
display_namestring-
oneof type.iambool-
oneof type.org_idstring-
oneof type.project_idstring-
oneof type.project_grant_idstring-

MembershipIAMQuery

this query is always equals

FieldTypeDescriptionValidation
iambool-

MembershipOrgQuery

this query is always equals

FieldTypeDescriptionValidation
org_idstring-string.max_len: 200

MembershipProjectGrantQuery

this query is always equals

FieldTypeDescriptionValidation
project_grant_idstring-string.max_len: 200

MembershipProjectQuery

this query is always equals

FieldTypeDescriptionValidation
project_idstring-string.max_len: 200

MembershipQuery

FieldTypeDescriptionValidation
oneof query.org_queryMembershipOrgQuery-
oneof query.project_queryMembershipProjectQuery-
oneof query.project_grant_queryMembershipProjectGrantQuery-
oneof query.iam_queryMembershipIAMQuery-

NickNameQuery

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

Phone

FieldTypeDescriptionValidation
phonestring-
is_phone_verifiedbool-

Profile

FieldTypeDescriptionValidation
first_namestring-
last_namestring-
nick_namestring-
display_namestring-
preferred_languagestring-
genderGender-
avatar_urlstring-

RefreshToken

FieldTypeDescriptionValidation
idstring-
detailszitadel.v1.ObjectDetails-
client_idstring-
auth_timegoogle.protobuf.Timestamp-
idle_expirationgoogle.protobuf.Timestamp-
expirationgoogle.protobuf.Timestamp-
scopesrepeated string-
audiencerepeated string-

SearchQuery

FieldTypeDescriptionValidation
oneof query.user_name_queryUserNameQuery-
oneof query.first_name_queryFirstNameQuery-
oneof query.last_name_queryLastNameQuery-
oneof query.nick_name_queryNickNameQuery-
oneof query.display_name_queryDisplayNameQuery-
oneof query.email_queryEmailQuery-
oneof query.state_queryStateQuery-
oneof query.type_queryTypeQuery-

Session

FieldTypeDescriptionValidation
session_idstring-
agent_idstring-
auth_stateSessionState-
user_idstring-
user_namestring-
login_namestring-
display_namestring-
detailszitadel.v1.ObjectDetails-
avatar_urlstring-

StateQuery

UserStateQuery is always equals

FieldTypeDescriptionValidation
stateUserState-enum.defined_only: true

TypeQuery

UserTypeQuery is always equals

FieldTypeDescriptionValidation
typeType-enum.defined_only: true

User

FieldTypeDescriptionValidation
idstring-
detailszitadel.v1.ObjectDetails-
stateUserState-
user_namestring-
login_namesrepeated string-
preferred_login_namestring-
oneof type.humanHuman-
oneof type.machineMachine-

UserGrant

FieldTypeDescriptionValidation
idstring-
detailszitadel.v1.ObjectDetails-
role_keysrepeated string-
stateUserGrantState-
user_idstring-
user_namestring-
first_namestring-
last_namestring-
emailstring-string.email: true
display_namestring-string.max_len: 200
org_idstring-
org_namestring-
org_domainstring-
project_idstring-
project_namestring-
project_grant_idstring-
avatar_urlstring-

UserGrantDisplayNameQuery

FieldTypeDescriptionValidation
display_namestring-
methodzitadel.v1.TextQueryMethod-enum.defined_only: true

UserGrantEmailQuery

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

UserGrantFirstNameQuery

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

UserGrantLastNameQuery

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

UserGrantOrgDomainQuery

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

UserGrantOrgNameQuery

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

UserGrantProjectGrantIDQuery

FieldTypeDescriptionValidation
project_grant_idstring-string.max_len: 200

UserGrantProjectIDQuery

FieldTypeDescriptionValidation
project_idstring-string.max_len: 200

UserGrantProjectNameQuery

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

UserGrantQuery

FieldTypeDescriptionValidation
oneof query.project_id_queryUserGrantProjectIDQuery-
oneof query.user_id_queryUserGrantUserIDQuery-
oneof query.with_granted_queryUserGrantWithGrantedQuery-
oneof query.role_key_queryUserGrantRoleKeyQuery-
oneof query.project_grant_id_queryUserGrantProjectGrantIDQuery-
oneof query.user_name_queryUserGrantUserNameQuery-
oneof query.first_name_queryUserGrantFirstNameQuery-
oneof query.last_name_queryUserGrantLastNameQuery-
oneof query.email_queryUserGrantEmailQuery-
oneof query.org_name_queryUserGrantOrgNameQuery-
oneof query.org_domain_queryUserGrantOrgDomainQuery-
oneof query.project_name_queryUserGrantProjectNameQuery-
oneof query.display_name_queryUserGrantDisplayNameQuery-
oneof query.user_type_queryUserGrantUserTypeQuery-

UserGrantRoleKeyQuery

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

UserGrantUserIDQuery

FieldTypeDescriptionValidation
user_idstring-string.max_len: 200

UserGrantUserNameQuery

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

UserGrantUserTypeQuery

FieldTypeDescriptionValidation
typeType-

UserGrantWithGrantedQuery

FieldTypeDescriptionValidation
with_grantedbool-

UserNameQuery

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

WebAuthNKey

FieldTypeDescriptionValidation
public_keybytes-

WebAuthNToken

FieldTypeDescriptionValidation
idstring-
stateAuthFactorState-
namestring-

WebAuthNVerification

FieldTypeDescriptionValidation
public_key_credentialbytes-bytes.min_len: 55
token_namestring-string.min_len: 1
string.max_len: 200

Enums

AuthFactorState

NameNumberDescription
AUTH_FACTOR_STATE_UNSPECIFIED0-
AUTH_FACTOR_STATE_NOT_READY1-
AUTH_FACTOR_STATE_READY2-
AUTH_FACTOR_STATE_REMOVED3-

Gender

NameNumberDescription
GENDER_UNSPECIFIED0-
GENDER_FEMALE1-
GENDER_MALE2-
GENDER_DIVERSE3-

SessionState

NameNumberDescription
SESSION_STATE_UNSPECIFIED0-
SESSION_STATE_ACTIVE1-
SESSION_STATE_TERMINATED2-

Type

NameNumberDescription
TYPE_UNSPECIFIED0-
TYPE_HUMAN1-
TYPE_MACHINE2-

UserFieldName

NameNumberDescription
USER_FIELD_NAME_UNSPECIFIED0-
USER_FIELD_NAME_USER_NAME1-
USER_FIELD_NAME_FIRST_NAME2-
USER_FIELD_NAME_LAST_NAME3-
USER_FIELD_NAME_NICK_NAME4-
USER_FIELD_NAME_DISPLAY_NAME5-
USER_FIELD_NAME_EMAIL6-
USER_FIELD_NAME_STATE7-
USER_FIELD_NAME_TYPE8-

UserGrantState

NameNumberDescription
USER_GRANT_STATE_UNSPECIFIED0-
USER_GRANT_STATE_ACTIVE1-
USER_GRANT_STATE_INACTIVE2-

UserState

NameNumberDescription
USER_STATE_UNSPECIFIED0-
USER_STATE_ACTIVE1-
USER_STATE_INACTIVE2-
USER_STATE_DELETED3-
USER_STATE_LOCKED4-
USER_STATE_SUSPEND5-
USER_STATE_INITIAL6-