@zitadel/node

import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire"; import Long from "long"; import type { CallContext, CallOptions } from "nice-grpc-common"; import { Details, ListDetails, RequestContext } from "../../object/v2/object.js"; import { BrandingSettings } from "./branding_settings.js"; import { DomainSettings } from "./domain_settings.js"; import { LegalAndSupportSettings } from "./legal_settings.js"; import { LockoutSettings } from "./lockout_settings.js"; import { IdentityProvider, LoginSettings } from "./login_settings.js"; import { PasswordComplexitySettings, PasswordExpirySettings } from "./password_settings.js"; import { EmbeddedIframeSettings, SecuritySettings } from "./security_settings.js"; export declare const protobufPackage = "zitadel.settings.v2"; export interface GetLoginSettingsRequest { ctx: RequestContext | undefined; } export interface GetLoginSettingsResponse { details: Details | undefined; settings: LoginSettings | undefined; } export interface GetPasswordComplexitySettingsRequest { ctx: RequestContext | undefined; } export interface GetPasswordComplexitySettingsResponse { details: Details | undefined; settings: PasswordComplexitySettings | undefined; } export interface GetPasswordExpirySettingsRequest { ctx: RequestContext | undefined; } export interface GetPasswordExpirySettingsResponse { details: Details | undefined; settings: PasswordExpirySettings | undefined; } export interface GetBrandingSettingsRequest { ctx: RequestContext | undefined; } export interface GetBrandingSettingsResponse { details: Details | undefined; settings: BrandingSettings | undefined; } export interface GetDomainSettingsRequest { ctx: RequestContext | undefined; } export interface GetDomainSettingsResponse { details: Details | undefined; settings: DomainSettings | undefined; } export interface GetLegalAndSupportSettingsRequest { ctx: RequestContext | undefined; } export interface GetLegalAndSupportSettingsResponse { details: Details | undefined; settings: LegalAndSupportSettings | undefined; } export interface GetLockoutSettingsRequest { ctx: RequestContext | undefined; } export interface GetLockoutSettingsResponse { details: Details | undefined; settings: LockoutSettings | undefined; } export interface GetActiveIdentityProvidersRequest { ctx: RequestContext | undefined; creationAllowed?: boolean | undefined; linkingAllowed?: boolean | undefined; autoCreation?: boolean | undefined; autoLinking?: boolean | undefined; } export interface GetActiveIdentityProvidersResponse { details: ListDetails | undefined; identityProviders: IdentityProvider[]; } export interface GetGeneralSettingsRequest { } export interface GetGeneralSettingsResponse { defaultOrgId: string; defaultLanguage: string; supportedLanguages: string[]; } /** This is an empty request */ export interface GetSecuritySettingsRequest { } export interface GetSecuritySettingsResponse { details: Details | undefined; settings: SecuritySettings | undefined; } export interface SetSecuritySettingsRequest { embeddedIframe: EmbeddedIframeSettings | undefined; enableImpersonation: boolean; } export interface SetSecuritySettingsResponse { details: Details | undefined; } export interface GetHostedLoginTranslationRequest { system?: boolean | undefined; instance?: boolean | undefined; organizationId?: string | undefined; locale: string; /** if set to true, higher levels are ignored, if false higher levels are merged into the file */ ignoreInheritance: boolean; } export interface GetHostedLoginTranslationResponse { /** hash of the payload */ etag: string; translations: { [key: string]: any; } | undefined; } export interface SetHostedLoginTranslationRequest { instance?: boolean | undefined; organizationId?: string | undefined; locale: string; translations: { [key: string]: any; } | undefined; } export interface SetHostedLoginTranslationResponse { /** hash of the saved translation. Valid only when ignore_inheritance = true */ etag: string; } export declare const GetLoginSettingsRequest: MessageFns<GetLoginSettingsRequest>; export declare const GetLoginSettingsResponse: MessageFns<GetLoginSettingsResponse>; export declare const GetPasswordComplexitySettingsRequest: MessageFns<GetPasswordComplexitySettingsRequest>; export declare const GetPasswordComplexitySettingsResponse: MessageFns<GetPasswordComplexitySettingsResponse>; export declare const GetPasswordExpirySettingsRequest: MessageFns<GetPasswordExpirySettingsRequest>; export declare const GetPasswordExpirySettingsResponse: MessageFns<GetPasswordExpirySettingsResponse>; export declare const GetBrandingSettingsRequest: MessageFns<GetBrandingSettingsRequest>; export declare const GetBrandingSettingsResponse: MessageFns<GetBrandingSettingsResponse>; export declare const GetDomainSettingsRequest: MessageFns<GetDomainSettingsRequest>; export declare const GetDomainSettingsResponse: MessageFns<GetDomainSettingsResponse>; export declare const GetLegalAndSupportSettingsRequest: MessageFns<GetLegalAndSupportSettingsRequest>; export declare const GetLegalAndSupportSettingsResponse: MessageFns<GetLegalAndSupportSettingsResponse>; export declare const GetLockoutSettingsRequest: MessageFns<GetLockoutSettingsRequest>; export declare const GetLockoutSettingsResponse: MessageFns<GetLockoutSettingsResponse>; export declare const GetActiveIdentityProvidersRequest: MessageFns<GetActiveIdentityProvidersRequest>; export declare const GetActiveIdentityProvidersResponse: MessageFns<GetActiveIdentityProvidersResponse>; export declare const GetGeneralSettingsRequest: MessageFns<GetGeneralSettingsRequest>; export declare const GetGeneralSettingsResponse: MessageFns<GetGeneralSettingsResponse>; export declare const GetSecuritySettingsRequest: MessageFns<GetSecuritySettingsRequest>; export declare const GetSecuritySettingsResponse: MessageFns<GetSecuritySettingsResponse>; export declare const SetSecuritySettingsRequest: MessageFns<SetSecuritySettingsRequest>; export declare const SetSecuritySettingsResponse: MessageFns<SetSecuritySettingsResponse>; export declare const GetHostedLoginTranslationRequest: MessageFns<GetHostedLoginTranslationRequest>; export declare const GetHostedLoginTranslationResponse: MessageFns<GetHostedLoginTranslationResponse>; export declare const SetHostedLoginTranslationRequest: MessageFns<SetHostedLoginTranslationRequest>; export declare const SetHostedLoginTranslationResponse: MessageFns<SetHostedLoginTranslationResponse>; export type SettingsServiceDefinition = typeof SettingsServiceDefinition; export declare const SettingsServiceDefinition: { readonly name: "SettingsService"; readonly fullName: "zitadel.settings.v2.SettingsService"; readonly methods: { /** Get basic information over the instance */ readonly getGeneralSettings: { readonly name: "GetGeneralSettings"; readonly requestType: MessageFns<GetGeneralSettingsRequest>; readonly requestStream: false; readonly responseType: MessageFns<GetGeneralSettingsResponse>; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Get the login settings */ readonly getLoginSettings: { readonly name: "GetLoginSettings"; readonly requestType: MessageFns<GetLoginSettingsRequest>; readonly requestStream: false; readonly responseType: MessageFns<GetLoginSettingsResponse>; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Get the current active identity providers */ readonly getActiveIdentityProviders: { readonly name: "GetActiveIdentityProviders"; readonly requestType: MessageFns<GetActiveIdentityProvidersRequest>; readonly requestStream: false; readonly responseType: MessageFns<GetActiveIdentityProvidersResponse>; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Get the password complexity settings */ readonly getPasswordComplexitySettings: { readonly name: "GetPasswordComplexitySettings"; readonly requestType: MessageFns<GetPasswordComplexitySettingsRequest>; readonly requestStream: false; readonly responseType: MessageFns<GetPasswordComplexitySettingsResponse>; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Get the password expiry settings */ readonly getPasswordExpirySettings: { readonly name: "GetPasswordExpirySettings"; readonly requestType: MessageFns<GetPasswordExpirySettingsRequest>; readonly requestStream: false; readonly responseType: MessageFns<GetPasswordExpirySettingsResponse>; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Get the current active branding settings */ readonly getBrandingSettings: { readonly name: "GetBrandingSettings"; readonly requestType: MessageFns<GetBrandingSettingsRequest>; readonly requestStream: false; readonly responseType: MessageFns<GetBrandingSettingsResponse>; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Get the domain settings */ readonly getDomainSettings: { readonly name: "GetDomainSettings"; readonly requestType: MessageFns<GetDomainSettingsRequest>; readonly requestStream: false; readonly responseType: MessageFns<GetDomainSettingsResponse>; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Get the legal and support settings */ readonly getLegalAndSupportSettings: { readonly name: "GetLegalAndSupportSettings"; readonly requestType: MessageFns<GetLegalAndSupportSettingsRequest>; readonly requestStream: false; readonly responseType: MessageFns<GetLegalAndSupportSettingsResponse>; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Get the lockout settings */ readonly getLockoutSettings: { readonly name: "GetLockoutSettings"; readonly requestType: MessageFns<GetLockoutSettingsRequest>; readonly requestStream: false; readonly responseType: MessageFns<GetLockoutSettingsResponse>; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Get the security settings */ readonly getSecuritySettings: { readonly name: "GetSecuritySettings"; readonly requestType: MessageFns<GetSecuritySettingsRequest>; readonly requestStream: false; readonly responseType: MessageFns<GetSecuritySettingsResponse>; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** Set the security settings */ readonly setSecuritySettings: { readonly name: "SetSecuritySettings"; readonly requestType: MessageFns<SetSecuritySettingsRequest>; readonly requestStream: false; readonly responseType: MessageFns<SetSecuritySettingsResponse>; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Get Hosted Login Translation * * Returns the translations in the requested locale for the hosted login. * The translations returned are based on the input level specified (system, instance or organization). * * If the requested level doesn't contain all translations, and ignore_inheritance is set to false, * a merging process fallbacks onto the higher levels ensuring all keys in the file have a translation, * which could be in the default language if the one of the locale is missing on all levels. * * The etag returned in the response represents the hash of the translations as they are stored on DB * and its reliable only if ignore_inheritance = true. * * Required permissions: * - `iam.policy.read` */ readonly getHostedLoginTranslation: { readonly name: "GetHostedLoginTranslation"; readonly requestType: MessageFns<GetHostedLoginTranslationRequest>; readonly requestStream: false; readonly responseType: MessageFns<GetHostedLoginTranslationResponse>; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; /** * Set Hosted Login Translation * * Sets the input translations at the specified level (instance or organization) for the input language. * * Required permissions: * - `iam.policy.write` */ readonly setHostedLoginTranslation: { readonly name: "SetHostedLoginTranslation"; readonly requestType: MessageFns<SetHostedLoginTranslationRequest>; readonly requestStream: false; readonly responseType: MessageFns<SetHostedLoginTranslationResponse>; readonly responseStream: false; readonly options: { readonly _unknownFields: { readonly 8338: readonly [Buffer]; readonly 400010: readonly [Buffer]; readonly 578365826: readonly [Buffer]; }; }; }; }; }; export interface SettingsServiceImplementation<CallContextExt = {}> { /** Get basic information over the instance */ getGeneralSettings(request: GetGeneralSettingsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<GetGeneralSettingsResponse>>; /** Get the login settings */ getLoginSettings(request: GetLoginSettingsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<GetLoginSettingsResponse>>; /** Get the current active identity providers */ getActiveIdentityProviders(request: GetActiveIdentityProvidersRequest, context: CallContext & CallContextExt): Promise<DeepPartial<GetActiveIdentityProvidersResponse>>; /** Get the password complexity settings */ getPasswordComplexitySettings(request: GetPasswordComplexitySettingsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<GetPasswordComplexitySettingsResponse>>; /** Get the password expiry settings */ getPasswordExpirySettings(request: GetPasswordExpirySettingsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<GetPasswordExpirySettingsResponse>>; /** Get the current active branding settings */ getBrandingSettings(request: GetBrandingSettingsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<GetBrandingSettingsResponse>>; /** Get the domain settings */ getDomainSettings(request: GetDomainSettingsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<GetDomainSettingsResponse>>; /** Get the legal and support settings */ getLegalAndSupportSettings(request: GetLegalAndSupportSettingsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<GetLegalAndSupportSettingsResponse>>; /** Get the lockout settings */ getLockoutSettings(request: GetLockoutSettingsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<GetLockoutSettingsResponse>>; /** Get the security settings */ getSecuritySettings(request: GetSecuritySettingsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<GetSecuritySettingsResponse>>; /** Set the security settings */ setSecuritySettings(request: SetSecuritySettingsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<SetSecuritySettingsResponse>>; /** * Get Hosted Login Translation * * Returns the translations in the requested locale for the hosted login. * The translations returned are based on the input level specified (system, instance or organization). * * If the requested level doesn't contain all translations, and ignore_inheritance is set to false, * a merging process fallbacks onto the higher levels ensuring all keys in the file have a translation, * which could be in the default language if the one of the locale is missing on all levels. * * The etag returned in the response represents the hash of the translations as they are stored on DB * and its reliable only if ignore_inheritance = true. * * Required permissions: * - `iam.policy.read` */ getHostedLoginTranslation(request: GetHostedLoginTranslationRequest, context: CallContext & CallContextExt): Promise<DeepPartial<GetHostedLoginTranslationResponse>>; /** * Set Hosted Login Translation * * Sets the input translations at the specified level (instance or organization) for the input language. * * Required permissions: * - `iam.policy.write` */ setHostedLoginTranslation(request: SetHostedLoginTranslationRequest, context: CallContext & CallContextExt): Promise<DeepPartial<SetHostedLoginTranslationResponse>>; } export interface SettingsServiceClient<CallOptionsExt = {}> { /** Get basic information over the instance */ getGeneralSettings(request: DeepPartial<GetGeneralSettingsRequest>, options?: CallOptions & CallOptionsExt): Promise<GetGeneralSettingsResponse>; /** Get the login settings */ getLoginSettings(request: DeepPartial<GetLoginSettingsRequest>, options?: CallOptions & CallOptionsExt): Promise<GetLoginSettingsResponse>; /** Get the current active identity providers */ getActiveIdentityProviders(request: DeepPartial<GetActiveIdentityProvidersRequest>, options?: CallOptions & CallOptionsExt): Promise<GetActiveIdentityProvidersResponse>; /** Get the password complexity settings */ getPasswordComplexitySettings(request: DeepPartial<GetPasswordComplexitySettingsRequest>, options?: CallOptions & CallOptionsExt): Promise<GetPasswordComplexitySettingsResponse>; /** Get the password expiry settings */ getPasswordExpirySettings(request: DeepPartial<GetPasswordExpirySettingsRequest>, options?: CallOptions & CallOptionsExt): Promise<GetPasswordExpirySettingsResponse>; /** Get the current active branding settings */ getBrandingSettings(request: DeepPartial<GetBrandingSettingsRequest>, options?: CallOptions & CallOptionsExt): Promise<GetBrandingSettingsResponse>; /** Get the domain settings */ getDomainSettings(request: DeepPartial<GetDomainSettingsRequest>, options?: CallOptions & CallOptionsExt): Promise<GetDomainSettingsResponse>; /** Get the legal and support settings */ getLegalAndSupportSettings(request: DeepPartial<GetLegalAndSupportSettingsRequest>, options?: CallOptions & CallOptionsExt): Promise<GetLegalAndSupportSettingsResponse>; /** Get the lockout settings */ getLockoutSettings(request: DeepPartial<GetLockoutSettingsRequest>, options?: CallOptions & CallOptionsExt): Promise<GetLockoutSettingsResponse>; /** Get the security settings */ getSecuritySettings(request: DeepPartial<GetSecuritySettingsRequest>, options?: CallOptions & CallOptionsExt): Promise<GetSecuritySettingsResponse>; /** Set the security settings */ setSecuritySettings(request: DeepPartial<SetSecuritySettingsRequest>, options?: CallOptions & CallOptionsExt): Promise<SetSecuritySettingsResponse>; /** * Get Hosted Login Translation * * Returns the translations in the requested locale for the hosted login. * The translations returned are based on the input level specified (system, instance or organization). * * If the requested level doesn't contain all translations, and ignore_inheritance is set to false, * a merging process fallbacks onto the higher levels ensuring all keys in the file have a translation, * which could be in the default language if the one of the locale is missing on all levels. * * The etag returned in the response represents the hash of the translations as they are stored on DB * and its reliable only if ignore_inheritance = true. * * Required permissions: * - `iam.policy.read` */ getHostedLoginTranslation(request: DeepPartial<GetHostedLoginTranslationRequest>, options?: CallOptions & CallOptionsExt): Promise<GetHostedLoginTranslationResponse>; /** * Set Hosted Login Translation * * Sets the input translations at the specified level (instance or organization) for the input language. * * Required permissions: * - `iam.policy.write` */ setHostedLoginTranslation(request: DeepPartial<SetHostedLoginTranslationRequest>, options?: CallOptions & CallOptionsExt): Promise<SetHostedLoginTranslationResponse>; } type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined; export type DeepPartial<T> = T extends Builtin ? T : T extends Long ? string | number | Long : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]>; } : Partial<T>; export interface MessageFns<T> { 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>): T; fromPartial(object: DeepPartial<T>): T; } export {};