zitadel/auth.md at c2fedbbfc6da5045ae52cb7a752dae5b98c3b1a9

mirror of https://github.com/zitadel/zitadel.git synced 2025-05-01 05:10:50 +00:00

* fix: generate admin api

* fix: generate admin api

* fix: generate admin api

* fix: http option

* fix: admin api

* fix: md files

* fix: correct headers

* fix: proto definitions

* fix: proto api

* fix: proto api

* fix: proto api

* fix: proto api

2021-04-15 18:21:46 +02:00

18 KiB

Raw Blame History

title
zitadel/auth.proto

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

AuthService

Healthz

rpc Healthz(HealthzRequest) HealthzResponse

GET: /healthz

GetMyUser

rpc GetMyUser(GetMyUserRequest) GetMyUserResponse

GET: /users/me

ListMyUserChanges

rpc ListMyUserChanges(ListMyUserChangesRequest) ListMyUserChangesResponse

POST: /users/me/changes/_search

ListMyUserSessions

rpc ListMyUserSessions(ListMyUserSessionsRequest) ListMyUserSessionsResponse

POST: /users/me/sessions/_search

UpdateMyUserName

rpc UpdateMyUserName(UpdateMyUserNameRequest) UpdateMyUserNameResponse

PUT: /users/me/username

GetMyPasswordComplexityPolicy

rpc GetMyPasswordComplexityPolicy(GetMyPasswordComplexityPolicyRequest) GetMyPasswordComplexityPolicyResponse

GET: /policies/passwords/complexity

UpdateMyPassword

rpc UpdateMyPassword(UpdateMyPasswordRequest) UpdateMyPasswordResponse

PUT: /users/me/password

GetMyProfile

rpc GetMyProfile(GetMyProfileRequest) GetMyProfileResponse

GET: /users/me/profile

UpdateMyProfile

rpc UpdateMyProfile(UpdateMyProfileRequest) UpdateMyProfileResponse

PUT: /users/me/profile

GetMyEmail

rpc GetMyEmail(GetMyEmailRequest) GetMyEmailResponse

GET: /users/me/email

SetMyEmail

rpc SetMyEmail(SetMyEmailRequest) SetMyEmailResponse

PUT: /users/me/email

VerifyMyEmail

rpc VerifyMyEmail(VerifyMyEmailRequest) VerifyMyEmailResponse

POST: /users/me/email/_verify

ResendMyEmailVerification

rpc ResendMyEmailVerification(ResendMyEmailVerificationRequest) ResendMyEmailVerificationResponse

POST: /users/me/email/_resend_verification

GetMyPhone

rpc GetMyPhone(GetMyPhoneRequest) GetMyPhoneResponse

GET: /users/me/phone

SetMyPhone

rpc SetMyPhone(SetMyPhoneRequest) SetMyPhoneResponse

PUT: /users/me/phone

VerifyMyPhone

rpc VerifyMyPhone(VerifyMyPhoneRequest) VerifyMyPhoneResponse

POST: /users/me/phone/_verify

ResendMyPhoneVerification

rpc ResendMyPhoneVerification(ResendMyPhoneVerificationRequest) ResendMyPhoneVerificationResponse

POST: /users/me/phone/_resend_verification

RemoveMyPhone

rpc RemoveMyPhone(RemoveMyPhoneRequest) RemoveMyPhoneResponse

DELETE: /users/me/phone

ListMyLinkedIDPs

rpc ListMyLinkedIDPs(ListMyLinkedIDPsRequest) ListMyLinkedIDPsResponse

POST: /users/me/idps/_search

RemoveMyLinkedIDP

rpc RemoveMyLinkedIDP(RemoveMyLinkedIDPRequest) RemoveMyLinkedIDPResponse

DELETE: /users/me/idps/{idp_id}/{linked_user_id}

ListMyAuthFactors

rpc ListMyAuthFactors(ListMyAuthFactorsRequest) ListMyAuthFactorsResponse

POST: /users/me/auth_factors/_search

AddMyAuthFactorOTP

rpc AddMyAuthFactorOTP(AddMyAuthFactorOTPRequest) AddMyAuthFactorOTPResponse

POST: /users/me/auth_factors/otp

VerifyMyAuthFactorOTP

rpc VerifyMyAuthFactorOTP(VerifyMyAuthFactorOTPRequest) VerifyMyAuthFactorOTPResponse

POST: /users/me/auth_factors/otp/_verify

RemoveMyAuthFactorOTP

rpc RemoveMyAuthFactorOTP(RemoveMyAuthFactorOTPRequest) RemoveMyAuthFactorOTPResponse

DELETE: /users/me/auth_factors/otp

AddMyAuthFactorU2F

rpc AddMyAuthFactorU2F(AddMyAuthFactorU2FRequest) AddMyAuthFactorU2FResponse

POST: /users/me/auth_factors/u2f

VerifyMyAuthFactorU2F

rpc VerifyMyAuthFactorU2F(VerifyMyAuthFactorU2FRequest) VerifyMyAuthFactorU2FResponse

POST: /users/me/auth_factors/u2f/_verify

RemoveMyAuthFactorU2F

rpc RemoveMyAuthFactorU2F(RemoveMyAuthFactorU2FRequest) RemoveMyAuthFactorU2FResponse

DELETE: /users/me/auth_factors/u2f/{token_id}

ListMyPasswordless

rpc ListMyPasswordless(ListMyPasswordlessRequest) ListMyPasswordlessResponse

POST: /users/me/passwordless/_search

AddMyPasswordless

rpc AddMyPasswordless(AddMyPasswordlessRequest) AddMyPasswordlessResponse

POST: /users/me/passwordless

VerifyMyPasswordless

rpc VerifyMyPasswordless(VerifyMyPasswordlessRequest) VerifyMyPasswordlessResponse

POST: /users/me/passwordless/_verify

RemoveMyPasswordless

rpc RemoveMyPasswordless(RemoveMyPasswordlessRequest) RemoveMyPasswordlessResponse

DELETE: /users/me/passwordless/{token_id}

ListMyUserGrants

rpc ListMyUserGrants(ListMyUserGrantsRequest) ListMyUserGrantsResponse

POST: /usergrants/me/_search

ListMyProjectOrgs

rpc ListMyProjectOrgs(ListMyProjectOrgsRequest) ListMyProjectOrgsResponse

POST: /global/projectorgs/_search

ListMyZitadelFeatures

rpc ListMyZitadelFeatures(ListMyZitadelFeaturesRequest) ListMyZitadelFeaturesResponse

POST: /features/zitadel/me/_search

ListMyZitadelPermissions

rpc ListMyZitadelPermissions(ListMyZitadelPermissionsRequest) ListMyZitadelPermissionsResponse

POST: /permissions/zitadel/me/_search

ListMyProjectPermissions

rpc ListMyProjectPermissions(ListMyProjectPermissionsRequest) ListMyProjectPermissionsResponse

POST: /permissions/me/_search

Messages

AddMyAuthFactorOTPRequest

Field	Type	Description

AddMyAuthFactorOTPResponse

Field	Type	Description
url	string	-
secret	string	-
details	zitadel.v1.ObjectDetails	-

AddMyAuthFactorU2FRequest

Field	Type	Description

AddMyAuthFactorU2FResponse

Field	Type	Description
key	zitadel.user.v1.WebAuthNKey	-
details	zitadel.v1.ObjectDetails	-

AddMyPasswordlessRequest

Field	Type	Description

AddMyPasswordlessResponse

Field	Type	Description
key	zitadel.user.v1.WebAuthNKey	-
details	zitadel.v1.ObjectDetails	-

GetMyEmailRequest

Field	Type	Description

GetMyEmailResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-
email	zitadel.user.v1.Email	-

GetMyPasswordComplexityPolicyRequest

Field	Type	Description

GetMyPasswordComplexityPolicyResponse

Field	Type	Description
policy	zitadel.policy.v1.PasswordComplexityPolicy	-

GetMyPhoneRequest

Field	Type	Description

GetMyPhoneResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-
phone	zitadel.user.v1.Phone	-

GetMyProfileRequest

Field	Type	Description

GetMyProfileResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-
profile	zitadel.user.v1.Profile	-

GetMyUserRequest

GetMyUserRequest is an empty request the request parameters are read from the token-header

Field	Type	Description

GetMyUserResponse

Field	Type	Description
user	zitadel.user.v1.User	-
last_login	google.protobuf.Timestamp	-

HealthzRequest

Field	Type	Description

HealthzResponse

Field	Type	Description

ListMyAuthFactorsRequest

Field	Type	Description

ListMyAuthFactorsResponse

Field	Type	Description
result	repeated zitadel.user.v1.AuthFactor	-

ListMyLinkedIDPsRequest

Field	Type	Description
query	zitadel.v1.ListQuery	list limitations and ordering

PLANNED: queries for idp name and login name |

ListMyLinkedIDPsResponse

Field	Type	Description
details	zitadel.v1.ListDetails	-
result	repeated zitadel.idp.v1.IDPUserLink	-

ListMyPasswordlessRequest

Field	Type	Description

ListMyPasswordlessResponse

Field	Type	Description
result	repeated zitadel.user.v1.WebAuthNToken	-

ListMyProjectOrgsRequest

Field	Type	Description
query	zitadel.v1.ListQuery	list limitations and ordering
queries	repeated zitadel.org.v1.OrgQuery	criterias the client is looking for

ListMyProjectOrgsResponse

Field	Type	Description
details	zitadel.v1.ListDetails	-
result	repeated zitadel.org.v1.Org	-

ListMyProjectPermissionsRequest

Field	Type	Description

ListMyProjectPermissionsResponse

Field	Type	Description
result	repeated string	-

ListMyUserChangesRequest

Field	Type	Description
query	zitadel.change.v1.ChangeQuery	-

ListMyUserChangesResponse

Field	Type	Description
details	zitadel.v1.ListDetails	-
result	repeated zitadel.change.v1.Change	-

ListMyUserGrantsRequest

Field	Type	Description
query	zitadel.v1.ListQuery	list limitations and ordering

ListMyUserGrantsResponse

Field	Type	Description
details	zitadel.v1.ListDetails	-
result	repeated UserGrant	-

ListMyUserSessionsRequest

Field	Type	Description

ListMyUserSessionsResponse

Field	Type	Description
result	repeated zitadel.user.v1.Session	-

ListMyZitadelFeaturesRequest

Field	Type	Description

ListMyZitadelFeaturesResponse

Field	Type	Description
result	repeated string	-

ListMyZitadelPermissionsRequest

Field	Type	Description

ListMyZitadelPermissionsResponse

Field	Type	Description
result	repeated string	-

RemoveMyAuthFactorOTPRequest

Field	Type	Description

RemoveMyAuthFactorOTPResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

RemoveMyAuthFactorU2FRequest

Field	Type	Description
token_id	string	-

RemoveMyAuthFactorU2FResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

RemoveMyLinkedIDPRequest

Field	Type	Description
idp_id	string	-
linked_user_id	string	-

RemoveMyLinkedIDPResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

RemoveMyPasswordlessRequest

Field	Type	Description
token_id	string	-

RemoveMyPasswordlessResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

RemoveMyPhoneRequest

Field	Type	Description

RemoveMyPhoneResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

ResendMyEmailVerificationRequest

Field	Type	Description

ResendMyEmailVerificationResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

ResendMyPhoneVerificationRequest

Field	Type	Description

ResendMyPhoneVerificationResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

SetMyEmailRequest

Field	Type	Description
email	string	TODO: check if no value is allowed

SetMyEmailResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

SetMyPhoneRequest

Field	Type	Description
phone	string	-

SetMyPhoneResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

UpdateMyPasswordRequest

Field	Type	Description
old_password	string	-
new_password	string	-

UpdateMyPasswordResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

UpdateMyProfileRequest

Field	Type	Description
first_name	string	-
last_name	string	-
nick_name	string	-
display_name	string	-
preferred_language	string	-
gender	zitadel.user.v1.Gender	-

UpdateMyProfileResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

UpdateMyUserNameRequest

Field	Type	Description
user_name	string	-

UpdateMyUserNameResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

UserGrant

Field	Type	Description
org_id	string	-
project_id	string	-
user_id	string	-
roles	repeated string	-
org_name	string	-
grant_id	string	-

VerifyMyAuthFactorOTPRequest

Field	Type	Description
code	string	-

VerifyMyAuthFactorOTPResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

VerifyMyAuthFactorU2FRequest

Field	Type	Description
verification	zitadel.user.v1.WebAuthNVerification	-

VerifyMyAuthFactorU2FResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

VerifyMyEmailRequest

Field	Type	Description
code	string	-

VerifyMyEmailResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

VerifyMyPasswordlessRequest

Field	Type	Description
verification	zitadel.user.v1.WebAuthNVerification	-

VerifyMyPasswordlessResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

VerifyMyPhoneRequest

Field	Type	Description
code	string	-

VerifyMyPhoneResponse

Field	Type	Description
details	zitadel.v1.ObjectDetails	-

18 KiB Raw Blame History