12f128e3c5
* doc: api descriptions * doc: management description * doc: message validation * doc: api descriptions * doc: api descriptions * doc: description * doc: index images * doc: design * colors, colors and more colors * margin * fix comment * doc: api descriptions * doc: empty response * doc: api descriptions * fix comment Co-authored-by: Livio Amstutz <livio.a@gmail.com>
38 KiB
| title |
|---|
| zitadel/admin.proto |
This document reflects the state from API 1.0 (available from 20.04.2021)
AdminService
Healthz
rpc Healthz(HealthzRequest) HealthzResponse
Indicates if ZITADEL is running. It respondes as soon as ZITADEL started
IsOrgUnique
rpc IsOrgUnique(IsOrgUniqueRequest) IsOrgUniqueResponse
Checks whether an organisation exists by the given parameters
GetOrgByID
rpc GetOrgByID(GetOrgByIDRequest) GetOrgByIDResponse
Returns an organisation by id
ListOrgs
rpc ListOrgs(ListOrgsRequest) ListOrgsResponse
Returns all organisations matching the request all queries need to match (AND)
SetUpOrg
rpc SetUpOrg(SetUpOrgRequest) SetUpOrgResponse
Creates a new org and user and adds the user to the orgs members as ORG_OWNER
GetIDPByID
rpc GetIDPByID(GetIDPByIDRequest) GetIDPByIDResponse
Returns a identity provider configuration of the IAM
ListIDPs
rpc ListIDPs(ListIDPsRequest) ListIDPsResponse
Returns all identity provider configurations of the IAM
AddOIDCIDP
rpc AddOIDCIDP(AddOIDCIDPRequest) AddOIDCIDPResponse
Adds a new oidc identity provider configuration the IAM
UpdateIDP
rpc UpdateIDP(UpdateIDPRequest) UpdateIDPResponse
Updates the specified idp all fields are updated. If no value is provided the field will be empty afterwards.
DeactivateIDP
rpc DeactivateIDP(DeactivateIDPRequest) DeactivateIDPResponse
Sets the state of the idp to IDP_STATE_INACTIVE the state MUST be IDP_STATE_ACTIVE for this call
ReactivateIDP
rpc ReactivateIDP(ReactivateIDPRequest) ReactivateIDPResponse
Sets the state of the idp to IDP_STATE_ACTIVE the state MUST be IDP_STATE_INACTIVE for this call
RemoveIDP
rpc RemoveIDP(RemoveIDPRequest) RemoveIDPResponse
RemoveIDP deletes the IDP permanetly
UpdateIDPOIDCConfig
rpc UpdateIDPOIDCConfig(UpdateIDPOIDCConfigRequest) UpdateIDPOIDCConfigResponse
Updates the oidc configuration of the specified idp all fields are updated. If no value is provided the field will be empty afterwards.
GetDefaultFeatures
rpc GetDefaultFeatures(GetDefaultFeaturesRequest) GetDefaultFeaturesResponse
SetDefaultFeatures
rpc SetDefaultFeatures(SetDefaultFeaturesRequest) SetDefaultFeaturesResponse
GetOrgFeatures
rpc GetOrgFeatures(GetOrgFeaturesRequest) GetOrgFeaturesResponse
SetOrgFeatures
rpc SetOrgFeatures(SetOrgFeaturesRequest) SetOrgFeaturesResponse
ResetOrgFeatures
rpc ResetOrgFeatures(ResetOrgFeaturesRequest) ResetOrgFeaturesResponse
GetOrgIAMPolicy
rpc GetOrgIAMPolicy(GetOrgIAMPolicyRequest) GetOrgIAMPolicyResponse
Returns the IAM policy defined by the administrators of ZITADEL
UpdateOrgIAMPolicy
rpc UpdateOrgIAMPolicy(UpdateOrgIAMPolicyRequest) UpdateOrgIAMPolicyResponse
Updates the default IAM policy. it impacts all organisations without a customised policy
GetCustomOrgIAMPolicy
rpc GetCustomOrgIAMPolicy(GetCustomOrgIAMPolicyRequest) GetCustomOrgIAMPolicyResponse
Returns the customised policy or the default if not customised
AddCustomOrgIAMPolicy
rpc AddCustomOrgIAMPolicy(AddCustomOrgIAMPolicyRequest) AddCustomOrgIAMPolicyResponse
Defines a custom ORGIAM policy as specified
UpdateCustomOrgIAMPolicy
rpc UpdateCustomOrgIAMPolicy(UpdateCustomOrgIAMPolicyRequest) UpdateCustomOrgIAMPolicyResponse
Updates a custom ORGIAM policy as specified
ResetCustomOrgIAMPolicyToDefault
rpc ResetCustomOrgIAMPolicyToDefault(ResetCustomOrgIAMPolicyToDefaultRequest) ResetCustomOrgIAMPolicyToDefaultResponse
Resets the org iam policy of the organisation to default ZITADEL will fallback to the default policy defined by the ZITADEL administrators
GetLabelPolicy
rpc GetLabelPolicy(GetLabelPolicyRequest) GetLabelPolicyResponse
Returns the label policy defined by the administrators of ZITADEL
UpdateLabelPolicy
rpc UpdateLabelPolicy(UpdateLabelPolicyRequest) UpdateLabelPolicyResponse
Updates the default label policy of ZITADEL it impacts all organisations without a customised policy
GetLoginPolicy
rpc GetLoginPolicy(GetLoginPolicyRequest) GetLoginPolicyResponse
Returns the login policy defined by the administrators of ZITADEL
UpdateLoginPolicy
rpc UpdateLoginPolicy(UpdateLoginPolicyRequest) UpdateLoginPolicyResponse
Updates the default login policy of ZITADEL it impacts all organisations without a customised policy
ListLoginPolicyIDPs
rpc ListLoginPolicyIDPs(ListLoginPolicyIDPsRequest) ListLoginPolicyIDPsResponse
Returns the idps linked to the default login policy, defined by the administrators of ZITADEL
AddIDPToLoginPolicy
rpc AddIDPToLoginPolicy(AddIDPToLoginPolicyRequest) AddIDPToLoginPolicyResponse
Adds the povided idp to the default login policy. It impacts all organisations without a customised policy
RemoveIDPFromLoginPolicy
rpc RemoveIDPFromLoginPolicy(RemoveIDPFromLoginPolicyRequest) RemoveIDPFromLoginPolicyResponse
Removes the povided idp from the default login policy. It impacts all organisations without a customised policy
ListLoginPolicySecondFactors
rpc ListLoginPolicySecondFactors(ListLoginPolicySecondFactorsRequest) ListLoginPolicySecondFactorsResponse
Returns the available second factors defined by the administrators of ZITADEL
AddSecondFactorToLoginPolicy
rpc AddSecondFactorToLoginPolicy(AddSecondFactorToLoginPolicyRequest) AddSecondFactorToLoginPolicyResponse
Adds a second factor to the default login policy. It impacts all organisations without a customised policy
RemoveSecondFactorFromLoginPolicy
rpc RemoveSecondFactorFromLoginPolicy(RemoveSecondFactorFromLoginPolicyRequest) RemoveSecondFactorFromLoginPolicyResponse
Removes a second factor from the default login policy. It impacts all organisations without a customised policy
ListLoginPolicyMultiFactors
rpc ListLoginPolicyMultiFactors(ListLoginPolicyMultiFactorsRequest) ListLoginPolicyMultiFactorsResponse
Returns the available multi factors defined by the administrators of ZITADEL
AddMultiFactorToLoginPolicy
rpc AddMultiFactorToLoginPolicy(AddMultiFactorToLoginPolicyRequest) AddMultiFactorToLoginPolicyResponse
Adds a multi factor to the default login policy. It impacts all organisations without a customised policy
RemoveMultiFactorFromLoginPolicy
rpc RemoveMultiFactorFromLoginPolicy(RemoveMultiFactorFromLoginPolicyRequest) RemoveMultiFactorFromLoginPolicyResponse
Removes a multi factor from the default login policy. It impacts all organisations without a customised policy
GetPasswordComplexityPolicy
rpc GetPasswordComplexityPolicy(GetPasswordComplexityPolicyRequest) GetPasswordComplexityPolicyResponse
Returns the password complexity policy defined by the administrators of ZITADEL
UpdatePasswordComplexityPolicy
rpc UpdatePasswordComplexityPolicy(UpdatePasswordComplexityPolicyRequest) UpdatePasswordComplexityPolicyResponse
Updates the default password complexity policy of ZITADEL it impacts all organisations without a customised policy
GetPasswordAgePolicy
rpc GetPasswordAgePolicy(GetPasswordAgePolicyRequest) GetPasswordAgePolicyResponse
Returns the password age policy defined by the administrators of ZITADEL
UpdatePasswordAgePolicy
rpc UpdatePasswordAgePolicy(UpdatePasswordAgePolicyRequest) UpdatePasswordAgePolicyResponse
Updates the default password age policy of ZITADEL it impacts all organisations without a customised policy
GetPasswordLockoutPolicy
rpc GetPasswordLockoutPolicy(GetPasswordLockoutPolicyRequest) GetPasswordLockoutPolicyResponse
Returns the password lockout policy defined by the administrators of ZITADEL
UpdatePasswordLockoutPolicy
rpc UpdatePasswordLockoutPolicy(UpdatePasswordLockoutPolicyRequest) UpdatePasswordLockoutPolicyResponse
Updates the default password lockout policy of ZITADEL it impacts all organisations without a customised policy
ListIAMMemberRoles
rpc ListIAMMemberRoles(ListIAMMemberRolesRequest) ListIAMMemberRolesResponse
Returns the IAM roles visible for the requested user
ListIAMMembers
rpc ListIAMMembers(ListIAMMembersRequest) ListIAMMembersResponse
Returns all members matching the request all queries need to match (ANDed)
AddIAMMember
rpc AddIAMMember(AddIAMMemberRequest) AddIAMMemberResponse
Adds a user to the membership list of ZITADEL with the given roles undefined roles will be dropped
UpdateIAMMember
rpc UpdateIAMMember(UpdateIAMMemberRequest) UpdateIAMMemberResponse
Sets the given roles on a member. The member has only roles provided by this call
RemoveIAMMember
rpc RemoveIAMMember(RemoveIAMMemberRequest) RemoveIAMMemberResponse
Removes the user from the membership list of ZITADEL
ListViews
rpc ListViews(ListViewsRequest) ListViewsResponse
Returns all stored read models of ZITADEL views are used for search optimisation and optimise request latencies they represent the delta of the event happend on the objects
ClearView
rpc ClearView(ClearViewRequest) ClearViewResponse
Truncates the delta of the change stream be carefull with this function because ZITADEL has to recompute the deltas after they got cleared. Search requests will return wrong results until all deltas are recomputed
ListFailedEvents
rpc ListFailedEvents(ListFailedEventsRequest) ListFailedEventsResponse
Returns event descriptions which cannot be processed. It's possible that some events need some retries. For example if the SMTP-API wasn't able to send an email at the first time
RemoveFailedEvent
rpc RemoveFailedEvent(RemoveFailedEventRequest) RemoveFailedEventResponse
Deletes the event from failed events view.
the event is not removed from the change stream
This call is usefull if the system was able to process the event later.
e.g. if the second try of sending an email was successful. the first try produced a
failed event. You can find out if it worked on the failure_count
Messages
AddCustomOrgIAMPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| org_id | string | - | string.min_len: 1 string.max_len: 200 |
| user_login_must_be_domain | bool | the username has to end with the domain of it's organisation (uniqueness is organisation based) |
AddCustomOrgIAMPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddIAMMemberRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| roles | repeated string | if no roles provided the user won't have any rights |
AddIAMMemberResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddIDPToLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | Id of the predefined idp configuration | string.min_len: 1 string.max_len: 200 |
AddIDPToLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddMultiFactorToLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| type | zitadel.policy.v1.MultiFactorType | - | enum.defined_only: true enum.not_in: [0] |
AddMultiFactorToLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddOIDCIDPRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| name | string | - | string.min_len: 1 string.max_len: 200 |
| styling_type | zitadel.idp.v1.IDPStylingType | - | enum.defined_only: true |
| client_id | string | - | string.min_len: 1 string.max_len: 200 |
| client_secret | string | - | string.min_len: 1 string.max_len: 200 |
| issuer | string | - | string.min_len: 1 string.max_len: 200 |
| scopes | repeated string | - | |
| display_name_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true |
| username_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true |
AddOIDCIDPResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - | |
| idp_id | string | - |
AddSecondFactorToLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| type | zitadel.policy.v1.SecondFactorType | - | enum.defined_only: true enum.not_in: [0] |
AddSecondFactorToLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ClearViewRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| database | string | - | string.min_len: 1 string.max_len: 200 |
| view_name | string | - | string.min_len: 1 string.max_len: 200 |
ClearViewResponse
This is an empty response
DeactivateIDPRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
DeactivateIDPResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
FailedEvent
| Field | Type | Description | Validation |
|---|---|---|---|
| database | string | - | |
| view_name | string | - | |
| failed_sequence | uint64 | - | |
| failure_count | uint64 | - | |
| error_message | string | - |
GetCustomOrgIAMPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| org_id | string | - | string.min_len: 1 string.max_len: 200 |
GetCustomOrgIAMPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.OrgIAMPolicy | - | |
| is_default | bool | - |
GetDefaultFeaturesRequest
GetDefaultFeaturesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| features | zitadel.features.v1.Features | - |
GetIDPByIDRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
GetIDPByIDResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| idp | zitadel.idp.v1.IDP | - |
GetLabelPolicyRequest
This is an empty request
GetLabelPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.LabelPolicy | - |
GetLoginPolicyRequest
This is an empty request
GetLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.LoginPolicy | - |
GetOrgByIDRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
GetOrgByIDResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| org | zitadel.org.v1.Org | - |
GetOrgFeaturesRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| org_id | string | - | string.min_len: 1 string.max_len: 200 |
GetOrgFeaturesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| features | zitadel.features.v1.Features | - |
GetOrgIAMPolicyRequest
GetOrgIAMPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.OrgIAMPolicy | - |
GetPasswordAgePolicyRequest
This is an empty request
GetPasswordAgePolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.PasswordAgePolicy | - |
GetPasswordComplexityPolicyRequest
GetPasswordComplexityPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.PasswordComplexityPolicy | - |
GetPasswordLockoutPolicyRequest
This is an empty request
GetPasswordLockoutPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.PasswordLockoutPolicy | - |
HealthzRequest
This is an empty request
HealthzResponse
This is an empty response
IDPQuery
| Field | Type | Description | Validation |
|---|---|---|---|
| oneof query.idp_id_query | zitadel.idp.v1.IDPIDQuery | - | |
| oneof query.idp_name_query | zitadel.idp.v1.IDPNameQuery | - |
IsOrgUniqueRequest
if name or domain is already in use, org is not unique
| Field | Type | Description | Validation |
|---|---|---|---|
| name | string | - | string.min_len: 1 string.max_len: 200 |
| domain | string | - | string.min_len: 1 string.max_len: 200 |
IsOrgUniqueResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| is_unique | bool | - |
ListFailedEventsRequest
This is an empty request
ListFailedEventsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| result | repeated FailedEvent | TODO: list details |
ListIAMMemberRolesRequest
This is an empty request
ListIAMMemberRolesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| roles | repeated string | - |
ListIAMMembersRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| queries | repeated zitadel.member.v1.SearchQuery | criterias the client is looking for |
ListIAMMembersResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.member.v1.Member | - |
ListIDPsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| sorting_column | zitadel.idp.v1.IDPFieldName | the field the result is sorted | |
| queries | repeated IDPQuery | criterias the client is looking for |
ListIDPsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| sorting_column | zitadel.idp.v1.IDPFieldName | - | |
| result | repeated zitadel.idp.v1.IDP | - |
ListLoginPolicyIDPsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | list limitations and ordering |
ListLoginPolicyIDPsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.idp.v1.IDPLoginPolicyLink | - |
ListLoginPolicyMultiFactorsRequest
This is an empty request
ListLoginPolicyMultiFactorsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.policy.v1.MultiFactorType | - |
ListLoginPolicySecondFactorsRequest
This is an empty request
ListLoginPolicySecondFactorsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.policy.v1.SecondFactorType | - |
ListOrgsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| sorting_column | zitadel.org.v1.OrgFieldName | the field the result is sorted | |
| queries | repeated zitadel.org.v1.OrgQuery | criterias the client is looking for |
ListOrgsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| sorting_column | zitadel.org.v1.OrgFieldName | - | |
| result | repeated zitadel.org.v1.Org | - |
ListViewsRequest
This is an empty request
ListViewsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| result | repeated View | TODO: list details |
ReactivateIDPRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
ReactivateIDPResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveFailedEventRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| database | string | - | string.min_len: 1 string.max_len: 200 |
| view_name | string | - | string.min_len: 1 string.max_len: 200 |
| failed_sequence | uint64 | - |
RemoveFailedEventResponse
This is an empty response
RemoveIAMMemberRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveIAMMemberResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveIDPFromLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveIDPFromLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveIDPRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveIDPResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveMultiFactorFromLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| type | zitadel.policy.v1.MultiFactorType | - | enum.defined_only: true enum.not_in: [0] |
RemoveMultiFactorFromLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveSecondFactorFromLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| type | zitadel.policy.v1.SecondFactorType | - | enum.defined_only: true enum.not_in: [0] |
RemoveSecondFactorFromLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResetCustomOrgIAMPolicyToDefaultRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| org_id | string | - | string.min_len: 1 string.max_len: 200 |
ResetCustomOrgIAMPolicyToDefaultResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResetOrgFeaturesRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| org_id | string | - | string.min_len: 1 string.max_len: 200 |
ResetOrgFeaturesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
SetDefaultFeaturesRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| tier_name | string | - | string.max_len: 200 |
| description | string | - | string.max_len: 200 |
| audit_log_retention | google.protobuf.Duration | - | duration.gte.seconds: 0 duration.gte.nanos: 0 |
| login_policy_username_login | bool | - | |
| login_policy_registration | bool | - | |
| login_policy_idp | bool | - | |
| login_policy_factors | bool | - | |
| login_policy_passwordless | bool | - | |
| password_complexity_policy | bool | - | |
| label_policy | bool | - | |
| custom_domain | bool | - |
SetDefaultFeaturesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
SetOrgFeaturesRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| org_id | string | - | string.min_len: 1 string.max_len: 200 |
| tier_name | string | - | string.max_len: 200 |
| description | string | - | string.max_len: 200 |
| state | zitadel.features.v1.FeaturesState | - | |
| state_description | string | - | string.max_len: 200 |
| audit_log_retention | google.protobuf.Duration | - | duration.gte.seconds: 0 duration.gte.nanos: 0 |
| login_policy_username_login | bool | - | |
| login_policy_registration | bool | - | |
| login_policy_idp | bool | - | |
| login_policy_factors | bool | - | |
| login_policy_passwordless | bool | - | |
| password_complexity_policy | bool | - | |
| label_policy | bool | - | |
| custom_domain | bool | - |
SetOrgFeaturesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
SetUpOrgRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| org | SetUpOrgRequest.Org | - | message.required: true |
| oneof user.human | SetUpOrgRequest.Human | oneof field for the user managing the organisation |
SetUpOrgRequest.Human
| Field | Type | Description | Validation |
|---|---|---|---|
| user_name | string | - | string.min_len: 1 string.max_len: 200 |
| profile | SetUpOrgRequest.Human.Profile | - | message.required: true |
| SetUpOrgRequest.Human.Email | - | message.required: true |
|
| phone | SetUpOrgRequest.Human.Phone | - | |
| password | string | - |
SetUpOrgRequest.Human.Email
| Field | Type | Description | Validation |
|---|---|---|---|
| string | TODO: check if no value is allowed | string.email: true |
|
| is_email_verified | bool | - |
SetUpOrgRequest.Human.Phone
| Field | Type | Description | Validation |
|---|---|---|---|
| phone | string | has to be a global number | string.min_len: 1 string.max_len: 50 string.prefix: + |
| is_phone_verified | bool | - |
SetUpOrgRequest.Human.Profile
| Field | Type | Description | Validation |
|---|---|---|---|
| first_name | string | - | string.min_len: 1 string.max_len: 200 |
| last_name | string | - | string.min_len: 1 string.max_len: 200 |
| nick_name | string | - | string.max_len: 200 |
| display_name | string | - | string.max_len: 200 |
| preferred_language | string | - | string.max_len: 10 |
| gender | zitadel.user.v1.Gender | - |
SetUpOrgRequest.Org
| Field | Type | Description | Validation |
|---|---|---|---|
| name | string | - | string.min_len: 1 string.max_len: 200 |
| domain | string | - | string.max_len: 200 |
SetUpOrgResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - | |
| org_id | string | - | |
| user_id | string | - |
UpdateCustomOrgIAMPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| org_id | string | - | string.min_len: 1 string.max_len: 200 |
| user_login_must_be_domain | bool | - |
UpdateCustomOrgIAMPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateIAMMemberRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| roles | repeated string | if no roles provided the user won't have any rights |
UpdateIAMMemberResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateIDPOIDCConfigRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
| issuer | string | - | string.min_len: 1 string.max_len: 200 |
| client_id | string | - | string.min_len: 1 string.max_len: 200 |
| client_secret | string | - | string.max_len: 200 |
| scopes | repeated string | - | |
| display_name_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true |
| username_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true |
UpdateIDPOIDCConfigResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateIDPRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
| name | string | - | string.min_len: 1 string.max_len: 200 |
| styling_type | zitadel.idp.v1.IDPStylingType | - | enum.defined_only: true |
UpdateIDPResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateLabelPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| primary_color | string | - | string.min_len: 1 string.max_len: 50 |
| secondary_color | string | - | string.min_len: 1 string.max_len: 50 |
| hide_login_name_suffix | bool | - |
UpdateLabelPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| allow_username_password | bool | - | |
| allow_register | bool | - | |
| allow_external_idp | bool | - | |
| force_mfa | bool | - | |
| passwordless_type | zitadel.policy.v1.PasswordlessType | - | enum.defined_only: true |
UpdateLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateOrgIAMPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_login_must_be_domain | bool | - |
UpdateOrgIAMPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdatePasswordAgePolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| max_age_days | uint32 | - | |
| expire_warn_days | uint32 | - |
UpdatePasswordAgePolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdatePasswordComplexityPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| min_length | uint32 | - | |
| has_uppercase | bool | - | |
| has_lowercase | bool | - | |
| has_number | bool | - | |
| has_symbol | bool | - |
UpdatePasswordComplexityPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdatePasswordLockoutPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| max_attempts | uint32 | failed attempts until a user gets locked | |
| show_lockout_failure | bool | If an error should be displayed during a lockout or not |
UpdatePasswordLockoutPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
View
| Field | Type | Description | Validation |
|---|---|---|---|
| database | string | - | |
| view_name | string | - | |
| processed_sequence | uint64 | - | |
| event_timestamp | google.protobuf.Timestamp | The timestamp the event occured | |
| last_successful_spooler_run | google.protobuf.Timestamp | - |