import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire"; import Long from "long"; import type { CallContext, CallOptions } from "nice-grpc-common"; import { Duration } from "../google/protobuf/duration.js"; import { KeyType } from "./auth_n_key.js"; import { InstanceFeature } from "./feature.js"; import { Domain, DomainFieldName, DomainSearchQuery, FieldName, Instance, InstanceDetail, Query } from "./instance.js"; import { Member, MemberFieldColumnName, SearchQuery } from "./member.js"; import { ListDetails, ListQuery, ObjectDetails } from "./object.js"; import { Notification, Unit } from "./quota.js"; export declare const protobufPackage = "zitadel.system.v1"; /** This is an empty request */ export interface HealthzRequest { } /** This is an empty response */ export interface HealthzResponse { } export interface ListInstancesRequest { /** list limitations and ordering */ query: ListQuery | undefined; /** the field the result is sorted */ sortingColumn: FieldName; /** criterias the client is looking for */ queries: Query[]; } export interface ListInstancesResponse { details: ListDetails | undefined; sortingColumn: FieldName; result: Instance[]; } export interface GetInstanceRequest { instanceId: string; } export interface GetInstanceResponse { instance: InstanceDetail | undefined; } export interface AddInstanceRequest { instanceName: string; firstOrgName: string; customDomain: string; ownerUserName: string; ownerEmail: AddInstanceRequest_Email | undefined; ownerProfile: AddInstanceRequest_Profile | undefined; ownerPassword: AddInstanceRequest_Password | undefined; defaultLanguage: string; } export interface AddInstanceRequest_Profile { firstName: string; lastName: string; preferredLanguage: string; } export interface AddInstanceRequest_Email { email: string; isEmailVerified: boolean; } export interface AddInstanceRequest_Password { password: string; passwordChangeRequired: boolean; } export interface AddInstanceResponse { instanceId: string; details: ObjectDetails | undefined; } export interface CreateInstanceRequest { instanceName: string; firstOrgName: string; customDomain: string; /** oneof field for the user managing the instance */ human?: CreateInstanceRequest_Human | undefined; machine?: CreateInstanceRequest_Machine | undefined; defaultLanguage: string; } export interface CreateInstanceRequest_Profile { firstName: string; lastName: string; preferredLanguage: string; } export interface CreateInstanceRequest_Email { email: string; isEmailVerified: boolean; } export interface CreateInstanceRequest_Password { password: string; passwordChangeRequired: boolean; } export interface CreateInstanceRequest_Human { userName: string; email: CreateInstanceRequest_Email | undefined; profile: CreateInstanceRequest_Profile | undefined; password: CreateInstanceRequest_Password | undefined; } export interface CreateInstanceRequest_PersonalAccessToken { expirationDate: Date | undefined; } export interface CreateInstanceRequest_MachineKey { type: KeyType; expirationDate: Date | undefined; } export interface CreateInstanceRequest_Machine { userName: string; name: string; personalAccessToken: CreateInstanceRequest_PersonalAccessToken | undefined; machineKey: CreateInstanceRequest_MachineKey | undefined; } export interface CreateInstanceResponse { instanceId: string; details: ObjectDetails | undefined; pat: string; machineKey: Buffer; } export interface UpdateInstanceRequest { instanceId: string; instanceName: string; } export interface UpdateInstanceResponse { details: ObjectDetails | undefined; } export interface RemoveInstanceRequest { instanceId: string; } export interface RemoveInstanceResponse { details: ObjectDetails | undefined; } export interface ListIAMMembersRequest { query: ListQuery | undefined; instanceId: string; queries: SearchQuery[]; sortingColumn: MemberFieldColumnName; } export interface ListIAMMembersResponse { details: ListDetails | undefined; result: Member[]; } export interface GetUsageRequest { instanceId: string; } export interface AddQuotaRequest { instanceId: string; /** the unit a quota should be imposed on */ unit: Unit; /** the starting time from which the current quota period is calculated from. This is relevant for querying the current usage. */ from: Date | undefined; /** the quota periods duration */ resetInterval: Duration | undefined; /** the quota amount of units */ amount: Long; /** whether ZITADEL should block further usage when the configured amount is used */ limit: boolean; /** the handlers, ZITADEL executes when certain quota percentages are reached */ notifications: Notification[]; } export interface AddQuotaResponse { details: ObjectDetails | undefined; } export interface SetQuotaRequest { instanceId: string; /** the unit a quota should be imposed on */ unit: Unit; /** the starting time from which the current quota period is calculated from. This is relevant for querying the current usage. */ from: Date | undefined; /** the quota periods duration */ resetInterval: Duration | undefined; /** the quota amount of units */ amount: Long; /** whether ZITADEL should block further usage when the configured amount is used */ limit: boolean; /** the handlers, ZITADEL executes when certain quota percentages are reached */ notifications: Notification[]; } export interface SetQuotaResponse { details: ObjectDetails | undefined; } export interface RemoveQuotaRequest { instanceId: string; unit: Unit; } export interface RemoveQuotaResponse { details: ObjectDetails | undefined; } export interface SetLimitsRequest { instanceId: string; auditLogRetention: Duration | undefined; block?: boolean | undefined; } export interface SetLimitsResponse { details: ObjectDetails | undefined; } export interface BulkSetLimitsRequest { limits: SetLimitsRequest[]; } export interface BulkSetLimitsResponse { details: ObjectDetails | undefined; targetDetails: ObjectDetails[]; } export interface ResetLimitsRequest { instanceId: string; } export interface ResetLimitsResponse { details: ObjectDetails | undefined; } export interface ExistsDomainRequest { domain: string; } export interface ExistsDomainResponse { exists: boolean; } export interface ListDomainsRequest { /** list limitations and ordering */ instanceId: string; query: ListQuery | undefined; /** the field the result is sorted */ sortingColumn: DomainFieldName; /** criterias the client is looking for */ queries: DomainSearchQuery[]; } export interface ListDomainsResponse { details: ListDetails | undefined; sortingColumn: DomainFieldName; result: Domain[]; } export interface AddDomainRequest { instanceId: string; domain: string; } export interface AddDomainResponse { details: ObjectDetails | undefined; } export interface RemoveDomainRequest { instanceId: string; domain: string; } export interface RemoveDomainResponse { details: ObjectDetails | undefined; } export interface SetPrimaryDomainRequest { instanceId: string; domain: string; } export interface SetPrimaryDomainResponse { details: ObjectDetails | undefined; } export interface ChangeSubscriptionRequest { domain: string; subscriptionName: string; requestLimit: Long; actionMinsLimit: Long; } export interface ChangeSubscriptionResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface ListViewsRequest { } export interface ListViewsResponse { /** TODO: list details */ result: View[]; } export interface ClearViewRequest { database: string; viewName: string; } /** This is an empty response */ export interface ClearViewResponse { } /** This is an empty request */ export interface ListFailedEventsRequest { } export interface ListFailedEventsResponse { /** TODO: list details */ result: FailedEvent[]; } export interface RemoveFailedEventRequest { database: string; viewName: string; failedSequence: Long; instanceId: string; } /** This is an empty response */ export interface RemoveFailedEventResponse { } export interface View { database: string; viewName: string; processedSequence: Long; /** The timestamp the event occured */ eventTimestamp: Date | undefined; lastSuccessfulSpoolerRun: Date | undefined; instance: string; } export interface FailedEvent { database: string; viewName: string; failedSequence: Long; failureCount: Long; errorMessage: string; lastFailed: Date | undefined; } export interface SetInstanceFeatureRequest { instanceId: string; featureId: InstanceFeature; bool?: boolean | undefined; } export interface SetInstanceFeatureResponse { details: ObjectDetails | undefined; } export declare const HealthzRequest: MessageFns; export declare const HealthzResponse: MessageFns; export declare const ListInstancesRequest: MessageFns; export declare const ListInstancesResponse: MessageFns; export declare const GetInstanceRequest: MessageFns; export declare const GetInstanceResponse: MessageFns; export declare const AddInstanceRequest: MessageFns; export declare const AddInstanceRequest_Profile: MessageFns; export declare const AddInstanceRequest_Email: MessageFns; export declare const AddInstanceRequest_Password: MessageFns; export declare const AddInstanceResponse: MessageFns; export declare const CreateInstanceRequest: MessageFns; export declare const CreateInstanceRequest_Profile: MessageFns; export declare const CreateInstanceRequest_Email: MessageFns; export declare const CreateInstanceRequest_Password: MessageFns; export declare const CreateInstanceRequest_Human: MessageFns; export declare const CreateInstanceRequest_PersonalAccessToken: MessageFns; export declare const CreateInstanceRequest_MachineKey: MessageFns; export declare const CreateInstanceRequest_Machine: MessageFns; export declare const CreateInstanceResponse: MessageFns; export declare const UpdateInstanceRequest: MessageFns; export declare const UpdateInstanceResponse: MessageFns; export declare const RemoveInstanceRequest: MessageFns; export declare const RemoveInstanceResponse: MessageFns; export declare const ListIAMMembersRequest: MessageFns; export declare const ListIAMMembersResponse: MessageFns; export declare const GetUsageRequest: MessageFns; export declare const AddQuotaRequest: MessageFns; export declare const AddQuotaResponse: MessageFns; export declare const SetQuotaRequest: MessageFns; export declare const SetQuotaResponse: MessageFns; export declare const RemoveQuotaRequest: MessageFns; export declare const RemoveQuotaResponse: MessageFns; export declare const SetLimitsRequest: MessageFns; export declare const SetLimitsResponse: MessageFns; export declare const BulkSetLimitsRequest: MessageFns; export declare const BulkSetLimitsResponse: MessageFns; export declare const ResetLimitsRequest: MessageFns; export declare const ResetLimitsResponse: MessageFns; export declare const ExistsDomainRequest: MessageFns; export declare const ExistsDomainResponse: MessageFns; export declare const ListDomainsRequest: MessageFns; export declare const ListDomainsResponse: MessageFns; export declare const AddDomainRequest: MessageFns; export declare const AddDomainResponse: MessageFns; export declare const RemoveDomainRequest: MessageFns; export declare const RemoveDomainResponse: MessageFns; export declare const SetPrimaryDomainRequest: MessageFns; export declare const SetPrimaryDomainResponse: MessageFns; export declare const ChangeSubscriptionRequest: MessageFns; export declare const ChangeSubscriptionResponse: MessageFns; export declare const ListViewsRequest: MessageFns; export declare const ListViewsResponse: MessageFns; export declare const ClearViewRequest: MessageFns; export declare const ClearViewResponse: MessageFns; export declare const ListFailedEventsRequest: MessageFns; export declare const ListFailedEventsResponse: MessageFns; export declare const RemoveFailedEventRequest: MessageFns; export declare const RemoveFailedEventResponse: MessageFns; export declare const View: MessageFns; export declare const FailedEvent: MessageFns; export declare const SetInstanceFeatureRequest: MessageFns; export declare const SetInstanceFeatureResponse: MessageFns; export type SystemServiceDefinition = typeof SystemServiceDefinition; export declare const SystemServiceDefinition: { readonly name: "SystemService"; readonly fullName: "zitadel.system.v1.SystemService"; readonly methods: { /** * Indicates if ZITADEL is running. * It respondes as soon as ZITADEL started */ readonly healthz: { readonly name: "Healthz"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Returns a list of ZITADEL instances * * Deprecated: Use [ListInstances](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-list-instances.api.mdx) instead to list instances */ readonly listInstances: { readonly name: "ListInstances"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Returns the detail of an instance * * Deprecated: Use [GetInstance](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-get-instance.api.mdx) instead to get the details of the instance in context */ readonly getInstance: { readonly name: "GetInstance"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Deprecated: Use CreateInstance instead * Creates a new instance with all needed setup data * This might take some time */ readonly addInstance: { readonly name: "AddInstance"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Updates name of an existing instance * * Deprecated: Use [UpdateInstance](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-update-instance.api.mdx) instead to update the name of the instance in context */ readonly updateInstance: { readonly name: "UpdateInstance"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Creates a new instance with all needed setup data * This might take some time */ readonly createInstance: { readonly name: "CreateInstance"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Removes an instance * This might take some time * * Deprecated: Use [DeleteInstance](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-delete-instance.api.mdx) instead to delete an instance */ readonly removeInstance: { readonly name: "RemoveInstance"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Returns all instance members matching the request * all queries need to match (ANDed) * Deprecated: Use the Admin APIs ListIAMMembers instead */ readonly listIAMMembers: { readonly name: "ListIAMMembers"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Checks if a domain exists * * Deprecated: Use [ListCustomDomains](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-list-custom-domains.api.mdx) instead to check existence of an instance */ readonly existsDomain: { readonly name: "ExistsDomain"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * List Domains * * Deprecated: use [instance service v2 ListCustomDomains](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-list-custom-domains.api.mdx) instead. * * Returns the custom domains of an instance. */ readonly listDomains: { readonly name: "ListDomains"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Adds a domain to an instance * * Deprecated: Use [AddCustomDomain](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-add-custom-domain.api.mdx) instead to add a custom domain to the instance in context */ readonly addDomain: { readonly name: "AddDomain"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Removes the domain of an instance * * Deprecated: Use [RemoveDomain](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-remove-custom-domain.api.mdx) instead to remove a custom domain from the instance in context */ readonly removeDomain: { readonly name: "RemoveDomain"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Sets the primary domain of an instance */ readonly setPrimaryDomain: { readonly name: "SetPrimaryDomain"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * 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 */ readonly listViews: { readonly name: "ListViews"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * 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 */ readonly clearView: { readonly name: "ClearView"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * 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 */ readonly listFailedEvents: { readonly name: "ListFailedEvents"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * 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` */ readonly removeFailedEvent: { readonly name: "RemoveFailedEvent"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Creates a new quota * Returns an error if the quota already exists for the specified unit * Deprecated: use SetQuota instead */ readonly addQuota: { readonly name: "AddQuota"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Sets quota configuration properties * Creates a new quota if it doesn't exist for the specified unit */ readonly setQuota: { readonly name: "SetQuota"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Removes a quota */ readonly removeQuota: { readonly name: "RemoveQuota"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Set a feature flag on an instance */ readonly setInstanceFeature: { readonly name: "SetInstanceFeature"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Sets instance level limits */ readonly setLimits: { readonly name: "SetLimits"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Sets many instance level limits */ readonly bulkSetLimits: { readonly name: "BulkSetLimits"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Resets instance level limits */ readonly resetLimits: { readonly name: "ResetLimits"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400002: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; }; }; export interface SystemServiceImplementation { /** * Indicates if ZITADEL is running. * It respondes as soon as ZITADEL started */ healthz(request: HealthzRequest, context: CallContext & CallContextExt): Promise>; /** * Returns a list of ZITADEL instances * * Deprecated: Use [ListInstances](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-list-instances.api.mdx) instead to list instances */ listInstances(request: ListInstancesRequest, context: CallContext & CallContextExt): Promise>; /** * Returns the detail of an instance * * Deprecated: Use [GetInstance](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-get-instance.api.mdx) instead to get the details of the instance in context */ getInstance(request: GetInstanceRequest, context: CallContext & CallContextExt): Promise>; /** * Deprecated: Use CreateInstance instead * Creates a new instance with all needed setup data * This might take some time */ addInstance(request: AddInstanceRequest, context: CallContext & CallContextExt): Promise>; /** * Updates name of an existing instance * * Deprecated: Use [UpdateInstance](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-update-instance.api.mdx) instead to update the name of the instance in context */ updateInstance(request: UpdateInstanceRequest, context: CallContext & CallContextExt): Promise>; /** * Creates a new instance with all needed setup data * This might take some time */ createInstance(request: CreateInstanceRequest, context: CallContext & CallContextExt): Promise>; /** * Removes an instance * This might take some time * * Deprecated: Use [DeleteInstance](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-delete-instance.api.mdx) instead to delete an instance */ removeInstance(request: RemoveInstanceRequest, context: CallContext & CallContextExt): Promise>; /** * Returns all instance members matching the request * all queries need to match (ANDed) * Deprecated: Use the Admin APIs ListIAMMembers instead */ listIAMMembers(request: ListIAMMembersRequest, context: CallContext & CallContextExt): Promise>; /** * Checks if a domain exists * * Deprecated: Use [ListCustomDomains](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-list-custom-domains.api.mdx) instead to check existence of an instance */ existsDomain(request: ExistsDomainRequest, context: CallContext & CallContextExt): Promise>; /** * List Domains * * Deprecated: use [instance service v2 ListCustomDomains](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-list-custom-domains.api.mdx) instead. * * Returns the custom domains of an instance. */ listDomains(request: ListDomainsRequest, context: CallContext & CallContextExt): Promise>; /** * Adds a domain to an instance * * Deprecated: Use [AddCustomDomain](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-add-custom-domain.api.mdx) instead to add a custom domain to the instance in context */ addDomain(request: AddDomainRequest, context: CallContext & CallContextExt): Promise>; /** * Removes the domain of an instance * * Deprecated: Use [RemoveDomain](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-remove-custom-domain.api.mdx) instead to remove a custom domain from the instance in context */ removeDomain(request: RemoveDomainRequest, context: CallContext & CallContextExt): Promise>; /** Sets the primary domain of an instance */ setPrimaryDomain(request: SetPrimaryDomainRequest, context: CallContext & CallContextExt): Promise>; /** * 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 */ listViews(request: ListViewsRequest, context: CallContext & CallContextExt): Promise>; /** * 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 */ clearView(request: ClearViewRequest, context: CallContext & CallContextExt): Promise>; /** * 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 */ listFailedEvents(request: ListFailedEventsRequest, context: CallContext & CallContextExt): Promise>; /** * 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` */ removeFailedEvent(request: RemoveFailedEventRequest, context: CallContext & CallContextExt): Promise>; /** * Creates a new quota * Returns an error if the quota already exists for the specified unit * Deprecated: use SetQuota instead */ addQuota(request: AddQuotaRequest, context: CallContext & CallContextExt): Promise>; /** * Sets quota configuration properties * Creates a new quota if it doesn't exist for the specified unit */ setQuota(request: SetQuotaRequest, context: CallContext & CallContextExt): Promise>; /** Removes a quota */ removeQuota(request: RemoveQuotaRequest, context: CallContext & CallContextExt): Promise>; /** Set a feature flag on an instance */ setInstanceFeature(request: SetInstanceFeatureRequest, context: CallContext & CallContextExt): Promise>; /** Sets instance level limits */ setLimits(request: SetLimitsRequest, context: CallContext & CallContextExt): Promise>; /** Sets many instance level limits */ bulkSetLimits(request: BulkSetLimitsRequest, context: CallContext & CallContextExt): Promise>; /** Resets instance level limits */ resetLimits(request: ResetLimitsRequest, context: CallContext & CallContextExt): Promise>; } export interface SystemServiceClient { /** * Indicates if ZITADEL is running. * It respondes as soon as ZITADEL started */ healthz(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Returns a list of ZITADEL instances * * Deprecated: Use [ListInstances](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-list-instances.api.mdx) instead to list instances */ listInstances(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Returns the detail of an instance * * Deprecated: Use [GetInstance](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-get-instance.api.mdx) instead to get the details of the instance in context */ getInstance(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Deprecated: Use CreateInstance instead * Creates a new instance with all needed setup data * This might take some time */ addInstance(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Updates name of an existing instance * * Deprecated: Use [UpdateInstance](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-update-instance.api.mdx) instead to update the name of the instance in context */ updateInstance(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Creates a new instance with all needed setup data * This might take some time */ createInstance(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Removes an instance * This might take some time * * Deprecated: Use [DeleteInstance](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-delete-instance.api.mdx) instead to delete an instance */ removeInstance(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Returns all instance members matching the request * all queries need to match (ANDed) * Deprecated: Use the Admin APIs ListIAMMembers instead */ listIAMMembers(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Checks if a domain exists * * Deprecated: Use [ListCustomDomains](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-list-custom-domains.api.mdx) instead to check existence of an instance */ existsDomain(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * List Domains * * Deprecated: use [instance service v2 ListCustomDomains](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-list-custom-domains.api.mdx) instead. * * Returns the custom domains of an instance. */ listDomains(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Adds a domain to an instance * * Deprecated: Use [AddCustomDomain](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-add-custom-domain.api.mdx) instead to add a custom domain to the instance in context */ addDomain(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Removes the domain of an instance * * Deprecated: Use [RemoveDomain](apis/resources/instance_service_v2/zitadel-instance-v-2-instance-service-remove-custom-domain.api.mdx) instead to remove a custom domain from the instance in context */ removeDomain(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** Sets the primary domain of an instance */ setPrimaryDomain(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * 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 */ listViews(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * 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 */ clearView(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * 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 */ listFailedEvents(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * 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` */ removeFailedEvent(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Creates a new quota * Returns an error if the quota already exists for the specified unit * Deprecated: use SetQuota instead */ addQuota(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Sets quota configuration properties * Creates a new quota if it doesn't exist for the specified unit */ setQuota(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** Removes a quota */ removeQuota(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** Set a feature flag on an instance */ setInstanceFeature(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** Sets instance level limits */ setLimits(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** Sets many instance level limits */ bulkSetLimits(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** Resets instance level limits */ resetLimits(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; } type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined; export type DeepPartial = T extends Builtin ? T : T extends Long ? string | number | Long : T extends globalThis.Array ? globalThis.Array> : T extends ReadonlyArray ? ReadonlyArray> : T extends {} ? { [K in keyof T]?: DeepPartial; } : Partial; export interface MessageFns { encode(message: T, writer?: BinaryWriter): BinaryWriter; decode(input: BinaryReader | Uint8Array, length?: number): T; fromJSON(object: any): T; toJSON(message: T): unknown; create(base?: DeepPartial): T; fromPartial(object: DeepPartial): T; } export {};