import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire"; import Long from "long"; import type { CallContext, CallOptions } from "nice-grpc-common"; import { PaginationRequest, PaginationResponse } from "../../filter/v2beta/filter.js"; import { Domain, DomainFieldName, DomainSearchQuery, FieldName, Instance, Query, TrustedDomain, TrustedDomainFieldName, TrustedDomainSearchQuery } from "./instance.js"; export declare const protobufPackage = "zitadel.instance.v2beta"; export interface DeleteInstanceRequest { instanceId: string; } export interface DeleteInstanceResponse { deletionDate: Date | undefined; } export interface GetInstanceRequest { instanceId: string; } export interface GetInstanceResponse { instance: Instance | undefined; } export interface UpdateInstanceRequest { /** used only to identify the instance to change. */ instanceId: string; instanceName: string; } export interface UpdateInstanceResponse { changeDate: Date | undefined; } export interface ListInstancesRequest { /** Criterias the client is looking for. */ queries: Query[]; /** Pagination and sorting. */ pagination: PaginationRequest | undefined; /** The field the result is sorted by. */ sortingColumn?: FieldName | undefined; } export interface ListInstancesResponse { /** The list of instances. */ instances: Instance[]; /** Contains the total number of instances matching the query and the applied limit. */ pagination: PaginationResponse | undefined; } export interface AddCustomDomainRequest { instanceId: string; domain: string; } export interface AddCustomDomainResponse { creationDate: Date | undefined; } export interface RemoveCustomDomainRequest { instanceId: string; domain: string; } export interface RemoveCustomDomainResponse { deletionDate: Date | undefined; } export interface ListCustomDomainsRequest { instanceId: string; /** Pagination and sorting. */ pagination: PaginationRequest | undefined; /** The field the result is sorted by. */ sortingColumn: DomainFieldName; /** Criterias the client is looking for. */ queries: DomainSearchQuery[]; } export interface ListCustomDomainsResponse { domains: Domain[]; /** Contains the total number of domains matching the query and the applied limit. */ pagination: PaginationResponse | undefined; } export interface AddTrustedDomainRequest { instanceId: string; domain: string; } export interface AddTrustedDomainResponse { creationDate: Date | undefined; } export interface RemoveTrustedDomainRequest { instanceId: string; domain: string; } export interface RemoveTrustedDomainResponse { deletionDate: Date | undefined; } export interface ListTrustedDomainsRequest { instanceId: string; /** Pagination and sorting. */ pagination: PaginationRequest | undefined; /** The field the result is sorted by. */ sortingColumn: TrustedDomainFieldName; /** Criterias the client is looking for. */ queries: TrustedDomainSearchQuery[]; } export interface ListTrustedDomainsResponse { trustedDomain: TrustedDomain[]; /** Contains the total number of domains matching the query and the applied limit. */ pagination: PaginationResponse | undefined; } export declare const DeleteInstanceRequest: MessageFns; export declare const DeleteInstanceResponse: MessageFns; export declare const GetInstanceRequest: MessageFns; export declare const GetInstanceResponse: MessageFns; export declare const UpdateInstanceRequest: MessageFns; export declare const UpdateInstanceResponse: MessageFns; export declare const ListInstancesRequest: MessageFns; export declare const ListInstancesResponse: MessageFns; export declare const AddCustomDomainRequest: MessageFns; export declare const AddCustomDomainResponse: MessageFns; export declare const RemoveCustomDomainRequest: MessageFns; export declare const RemoveCustomDomainResponse: MessageFns; export declare const ListCustomDomainsRequest: MessageFns; export declare const ListCustomDomainsResponse: MessageFns; export declare const AddTrustedDomainRequest: MessageFns; export declare const AddTrustedDomainResponse: MessageFns; export declare const RemoveTrustedDomainRequest: MessageFns; export declare const RemoveTrustedDomainResponse: MessageFns; export declare const ListTrustedDomainsRequest: MessageFns; export declare const ListTrustedDomainsResponse: MessageFns; /** * Service to manage instances and their domains. * The service provides methods to create, update, delete and list instances and their domains. * * Deprecated: use instance service v2 instead. This service will be removed in the next major version of ZITADEL. */ export type InstanceServiceDefinition = typeof InstanceServiceDefinition; export declare const InstanceServiceDefinition: { readonly name: "InstanceService"; readonly fullName: "zitadel.instance.v2beta.InstanceService"; readonly methods: { /** * Delete Instance * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Deletes an instance with the given ID. * * Required permissions: * - `system.instance.delete` */ readonly deleteInstance: { readonly name: "DeleteInstance"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Get Instance * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Returns the instance in the current context. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.read` */ 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 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Update Instance * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Updates instance in context with the given name. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.write` */ 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 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * List Instances * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Lists instances matching the given query. * The query can be used to filter either by instance ID or domain. * The request is paginated and returns 100 results by default. * * Required permissions: * - `system.instance.read` */ 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 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Add Custom Domain * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Adds a custom domain to the instance in context. * * The instance_id in the input message will be used in the future * * Required permissions: * - `system.domain.write` */ readonly addCustomDomain: { readonly name: "AddCustomDomain"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Remove Custom Domain * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Removes a custom domain from the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `system.domain.write` */ readonly removeCustomDomain: { readonly name: "RemoveCustomDomain"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * List Custom Domains * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Lists custom domains of the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.read` */ readonly listCustomDomains: { readonly name: "ListCustomDomains"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Add Trusted Domain * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Adds a trusted domain to the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.write` */ readonly addTrustedDomain: { readonly name: "AddTrustedDomain"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Remove Trusted Domain * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Removes a trusted domain from the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.write` */ readonly removeTrustedDomain: { readonly name: "RemoveTrustedDomain"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * List Trusted Domains * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Lists trusted domains of the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.read` */ readonly listTrustedDomains: { readonly name: "ListTrustedDomains"; readonly requestType: MessageFns; readonly requestStream: false; readonly responseType: MessageFns; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; }; }; export interface InstanceServiceImplementation { /** * Delete Instance * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Deletes an instance with the given ID. * * Required permissions: * - `system.instance.delete` */ deleteInstance(request: DeleteInstanceRequest, context: CallContext & CallContextExt): Promise>; /** * Get Instance * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Returns the instance in the current context. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.read` */ getInstance(request: GetInstanceRequest, context: CallContext & CallContextExt): Promise>; /** * Update Instance * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Updates instance in context with the given name. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.write` */ updateInstance(request: UpdateInstanceRequest, context: CallContext & CallContextExt): Promise>; /** * List Instances * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Lists instances matching the given query. * The query can be used to filter either by instance ID or domain. * The request is paginated and returns 100 results by default. * * Required permissions: * - `system.instance.read` */ listInstances(request: ListInstancesRequest, context: CallContext & CallContextExt): Promise>; /** * Add Custom Domain * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Adds a custom domain to the instance in context. * * The instance_id in the input message will be used in the future * * Required permissions: * - `system.domain.write` */ addCustomDomain(request: AddCustomDomainRequest, context: CallContext & CallContextExt): Promise>; /** * Remove Custom Domain * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Removes a custom domain from the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `system.domain.write` */ removeCustomDomain(request: RemoveCustomDomainRequest, context: CallContext & CallContextExt): Promise>; /** * List Custom Domains * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Lists custom domains of the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.read` */ listCustomDomains(request: ListCustomDomainsRequest, context: CallContext & CallContextExt): Promise>; /** * Add Trusted Domain * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Adds a trusted domain to the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.write` */ addTrustedDomain(request: AddTrustedDomainRequest, context: CallContext & CallContextExt): Promise>; /** * Remove Trusted Domain * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Removes a trusted domain from the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.write` */ removeTrustedDomain(request: RemoveTrustedDomainRequest, context: CallContext & CallContextExt): Promise>; /** * List Trusted Domains * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Lists trusted domains of the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.read` */ listTrustedDomains(request: ListTrustedDomainsRequest, context: CallContext & CallContextExt): Promise>; } export interface InstanceServiceClient { /** * Delete Instance * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Deletes an instance with the given ID. * * Required permissions: * - `system.instance.delete` */ deleteInstance(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Get Instance * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Returns the instance in the current context. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.read` */ getInstance(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Update Instance * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Updates instance in context with the given name. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.write` */ updateInstance(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * List Instances * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Lists instances matching the given query. * The query can be used to filter either by instance ID or domain. * The request is paginated and returns 100 results by default. * * Required permissions: * - `system.instance.read` */ listInstances(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Add Custom Domain * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Adds a custom domain to the instance in context. * * The instance_id in the input message will be used in the future * * Required permissions: * - `system.domain.write` */ addCustomDomain(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Remove Custom Domain * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Removes a custom domain from the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `system.domain.write` */ removeCustomDomain(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * List Custom Domains * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Lists custom domains of the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.read` */ listCustomDomains(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Add Trusted Domain * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Adds a trusted domain to the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.write` */ addTrustedDomain(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * Remove Trusted Domain * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Removes a trusted domain from the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.write` */ removeTrustedDomain(request: DeepPartial, options?: CallOptions & CallOptionsExt): Promise; /** * List Trusted Domains * * Deprecated: please move to the corresponding endpoint under instance service v2. This endpoint will be removed with the next major version of ZITADEL. * * Lists trusted domains of the instance. * * The instance_id in the input message will be used in the future. * * Required permissions: * - `iam.read` */ listTrustedDomains(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 {};