TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-06-03 00:18:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
zitadel/docs/docs/apis/proto/user.md
Max Peintner df4a173264
feat(console): machine user accesstoken type (#5196) 
Set machine user Access Token type
2023-02-14 17:05:55 +01:00

17 KiB
Raw Blame History

title
zitadel/user.proto

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

Messages

AuthFactor

Field Type Description Validation
state AuthFactorState -
oneof type.otp AuthFactorOTP -
oneof type.u2f AuthFactorU2F -

AuthFactorOTP

AuthFactorU2F

Field Type Description Validation
id string -
name string -

DisplayNameQuery

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

Email

Field Type Description Validation
email string -
is_email_verified bool -

EmailQuery

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

FirstNameQuery

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

Human

Field Type Description Validation
profile Profile -
email Email -
phone Phone -

LastNameQuery

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

LoginNameQuery

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

Machine

Field Type Description Validation
name string -
description string -
has_secret bool -
access_token_type AccessTokenType -

Membership

Field Type Description Validation
user_id string -
details zitadel.v1.ObjectDetails -
roles repeated string -
display_name string -
oneof type.iam bool -
oneof type.org_id string -
oneof type.project_id string -
oneof type.project_grant_id string -

MembershipIAMQuery

this query is always equals

Field Type Description Validation
iam bool -

MembershipOrgQuery

this query is always equals

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

MembershipProjectGrantQuery

this query is always equals

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

MembershipProjectQuery

this query is always equals

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

MembershipQuery

Field Type Description Validation
oneof query.org_query MembershipOrgQuery -
oneof query.project_query MembershipProjectQuery -
oneof query.project_grant_query MembershipProjectGrantQuery -
oneof query.iam_query MembershipIAMQuery -

NickNameQuery

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

PersonalAccessToken

Field Type Description Validation
id string -
details zitadel.v1.ObjectDetails -
expiration_date google.protobuf.Timestamp -
scopes repeated string -

Phone

Field Type Description Validation
phone string -
is_phone_verified bool -

Profile

Field Type Description Validation
first_name string -
last_name string -
nick_name string -
display_name string -
preferred_language string -
gender Gender -
avatar_url string -

RefreshToken

Field Type Description Validation
id string -
details zitadel.v1.ObjectDetails -
client_id string -
auth_time google.protobuf.Timestamp -
idle_expiration google.protobuf.Timestamp -
expiration google.protobuf.Timestamp -
scopes repeated string -
audience repeated string -

SearchQuery

Field Type Description Validation
oneof query.user_name_query UserNameQuery -
oneof query.first_name_query FirstNameQuery -
oneof query.last_name_query LastNameQuery -
oneof query.nick_name_query NickNameQuery -
oneof query.display_name_query DisplayNameQuery -
oneof query.email_query EmailQuery -
oneof query.state_query StateQuery -
oneof query.type_query TypeQuery -
oneof query.login_name_query LoginNameQuery -

Session

Field Type Description Validation
session_id string -
agent_id string -
auth_state SessionState -
user_id string -
user_name string -
login_name string -
display_name string -
details zitadel.v1.ObjectDetails -
avatar_url string -

StateQuery

UserStateQuery is always equals

Field Type Description Validation
state UserState - enum.defined_only: true

TypeQuery

UserTypeQuery is always equals

Field Type Description Validation
type Type - enum.defined_only: true

User

Field Type Description Validation
id string -
details zitadel.v1.ObjectDetails -
state UserState -
user_name string -
login_names repeated string -
preferred_login_name string -
oneof type.human Human -
oneof type.machine Machine -

UserGrant

Field Type Description Validation
id string -
details zitadel.v1.ObjectDetails -
role_keys repeated string -
state UserGrantState -
user_id string -
user_name string -
first_name string -
last_name string -
email string - string.email: true
display_name string - string.max_len: 200
org_id string -
org_name string -
org_domain string -
project_id string -
project_name string -
project_grant_id string -
avatar_url string -
preferred_login_name string -

UserGrantDisplayNameQuery

Field Type Description Validation
display_name string -
method zitadel.v1.TextQueryMethod - enum.defined_only: true

UserGrantEmailQuery

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

UserGrantFirstNameQuery

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

UserGrantLastNameQuery

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

UserGrantOrgDomainQuery

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

UserGrantOrgNameQuery

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

UserGrantProjectGrantIDQuery

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

UserGrantProjectIDQuery

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

UserGrantProjectNameQuery

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

UserGrantQuery

Field Type Description Validation
oneof query.project_id_query UserGrantProjectIDQuery -
oneof query.user_id_query UserGrantUserIDQuery -
oneof query.with_granted_query UserGrantWithGrantedQuery -
oneof query.role_key_query UserGrantRoleKeyQuery -
oneof query.project_grant_id_query UserGrantProjectGrantIDQuery -
oneof query.user_name_query UserGrantUserNameQuery -
oneof query.first_name_query UserGrantFirstNameQuery -
oneof query.last_name_query UserGrantLastNameQuery -
oneof query.email_query UserGrantEmailQuery -
oneof query.org_name_query UserGrantOrgNameQuery -
oneof query.org_domain_query UserGrantOrgDomainQuery -
oneof query.project_name_query UserGrantProjectNameQuery -
oneof query.display_name_query UserGrantDisplayNameQuery -
oneof query.user_type_query UserGrantUserTypeQuery -

UserGrantRoleKeyQuery

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

UserGrantUserIDQuery

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

UserGrantUserNameQuery

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

UserGrantUserTypeQuery

Field Type Description Validation
type Type -

UserGrantWithGrantedQuery

Field Type Description Validation
with_granted bool -

UserNameQuery

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

WebAuthNKey

Field Type Description Validation
public_key bytes -

WebAuthNToken

Field Type Description Validation
id string -
state AuthFactorState -
name string -

WebAuthNVerification

Field Type Description Validation
public_key_credential bytes - bytes.min_len: 55
token_name string - string.min_len: 1
string.max_len: 200

Enums

AccessTokenType

Name Number Description
ACCESS_TOKEN_TYPE_BEARER 0 -
ACCESS_TOKEN_TYPE_JWT 1 -

AuthFactorState

Name Number Description
AUTH_FACTOR_STATE_UNSPECIFIED 0 -
AUTH_FACTOR_STATE_NOT_READY 1 -
AUTH_FACTOR_STATE_READY 2 -
AUTH_FACTOR_STATE_REMOVED 3 -

Gender

Name Number Description
GENDER_UNSPECIFIED 0 -
GENDER_FEMALE 1 -
GENDER_MALE 2 -
GENDER_DIVERSE 3 -

SessionState

Name Number Description
SESSION_STATE_UNSPECIFIED 0 -
SESSION_STATE_ACTIVE 1 -
SESSION_STATE_TERMINATED 2 -

Type

Name Number Description
TYPE_UNSPECIFIED 0 -
TYPE_HUMAN 1 -
TYPE_MACHINE 2 -

UserFieldName

Name Number Description
USER_FIELD_NAME_UNSPECIFIED 0 -
USER_FIELD_NAME_USER_NAME 1 -
USER_FIELD_NAME_FIRST_NAME 2 -
USER_FIELD_NAME_LAST_NAME 3 -
USER_FIELD_NAME_NICK_NAME 4 -
USER_FIELD_NAME_DISPLAY_NAME 5 -
USER_FIELD_NAME_EMAIL 6 -
USER_FIELD_NAME_STATE 7 -
USER_FIELD_NAME_TYPE 8 -

UserGrantState

Name Number Description
USER_GRANT_STATE_UNSPECIFIED 0 -
USER_GRANT_STATE_ACTIVE 1 -
USER_GRANT_STATE_INACTIVE 2 -

UserState

Name Number Description
USER_STATE_UNSPECIFIED 0 -
USER_STATE_ACTIVE 1 -
USER_STATE_INACTIVE 2 -
USER_STATE_DELETED 3 -
USER_STATE_LOCKED 4 -
USER_STATE_SUSPEND 5 -
USER_STATE_INITIAL 6 -