UNPKG

@primerouting/zitadel-node

Version:

Library for API access to ZITADEL. Provides compiled gRPC service clients and helpers for applications and service accounts. Support http2 self-hosted instances

1,677 lines 1 MB
import Long from "long"; import { type CallContext, type CallOptions } from "nice-grpc-common"; import _m0 from "protobufjs/minimal"; import { Duration } from "../google/protobuf/duration"; import { Action, ActionFieldName, ActionIDQuery, ActionNameQuery, ActionStateQuery, Flow, FlowType, TriggerType } from "./action"; import { APIAuthMethodType, App, AppQuery, OIDCAppType, OIDCAuthMethodType, OIDCGrantType, OIDCResponseType, OIDCTokenType, OIDCVersion } from "./app"; import { Key, KeyType } from "./auth_n_key"; import { Change, ChangeQuery } from "./change"; import { AzureADTenant, IDP, IDPFieldName, IDPIDQuery, IDPLoginPolicyLink, IDPNameQuery, IDPOwnerType, IDPOwnerTypeQuery, IDPStylingType, IDPUserLink, LDAPAttributes, OIDCMappingField, Options, Provider, SAMLBinding, SAMLNameIDFormat } from "./idp"; import { Member, SearchQuery as SearchQuery1 } from "./member"; import { LocalizedMessage } from "./message"; import { Metadata, MetadataQuery } from "./metadata"; import { ListDetails, ListQuery, ObjectDetails } from "./object"; import { Domain, DomainSearchQuery, DomainValidationType, Org } from "./org"; import { DomainPolicy, LabelPolicy, LockoutPolicy, LoginPolicy, MultiFactorType, NotificationPolicy, OrgIAMPolicy, PasswordAgePolicy, PasswordComplexityPolicy, PasswordlessType, PrivacyPolicy, SecondFactorType, ThemeMode } from "./policy"; import { AllProjectGrantQuery, GrantedProject, PrivateLabelingSetting, Project, ProjectGrantQuery, ProjectQuery, Role, RoleQuery } from "./project"; import { EmailVerificationDoneScreenText, EmailVerificationScreenText, ExternalRegistrationUserOverviewScreenText, ExternalUserNotFoundScreenText, FooterText, InitializeUserDoneScreenText, InitializeUserScreenText, InitMFADoneScreenText, InitMFAOTPScreenText, InitMFAPromptScreenText, InitMFAU2FScreenText, InitPasswordDoneScreenText, InitPasswordScreenText, LinkingUserDoneScreenText, LinkingUserPromptScreenText, LoginCustomText, LoginScreenText, LogoutDoneScreenText, MessageCustomText, MFAProvidersText, PasswordChangeDoneScreenText, PasswordChangeScreenText, PasswordlessPromptScreenText, PasswordlessRegistrationDoneScreenText, PasswordlessRegistrationScreenText, PasswordlessScreenText, PasswordResetDoneScreenText, PasswordScreenText, RegistrationOptionScreenText, RegistrationOrgScreenText, RegistrationUserScreenText, SelectAccountScreenText, SuccessLoginScreenText, UsernameChangeDoneScreenText, UsernameChangeScreenText, VerifyMFAOTPScreenText, VerifyMFAU2FScreenText } from "./text"; import { AccessTokenType, AuthFactor, Email, Gender, Membership, MembershipQuery, PersonalAccessToken, Phone, Profile, SearchQuery, User, UserFieldName, UserGrant, UserGrantQuery, WebAuthNToken } from "./user"; export declare const protobufPackage = "zitadel.management.v1"; /** This is an empty request */ export interface HealthzRequest { } /** This is an empty response */ export interface HealthzResponse { } /** This is an empty request */ export interface GetOIDCInformationRequest { } export interface GetOIDCInformationResponse { issuer: string; discoveryEndpoint: string; } /** This is an empty request */ export interface GetIAMRequest { } export interface GetIAMResponse { /** deprecated: use default_org_id instead */ globalOrgId: string; iamProjectId: string; defaultOrgId: string; } /** This is an empty request */ export interface GetSupportedLanguagesRequest { } export interface GetSupportedLanguagesResponse { languages: string[]; } export interface GetUserByIDRequest { id: string; } export interface GetUserByIDResponse { user: User | undefined; } export interface GetUserByLoginNameGlobalRequest { loginName: string; } export interface GetUserByLoginNameGlobalResponse { user: User | undefined; } export interface ListUsersRequest { /** list limitations and ordering */ query: ListQuery | undefined; /** the field the result is sorted */ sortingColumn: UserFieldName; /** criteria the client is looking for */ queries: SearchQuery[]; } export interface ListUsersResponse { details: ListDetails | undefined; sortingColumn: UserFieldName; result: User[]; } export interface ListUserChangesRequest { /** list limitations and ordering */ query: ChangeQuery | undefined; userId: string; } export interface ListUserChangesResponse { /** zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary info) */ result: Change[]; } export interface IsUserUniqueRequest { userName: string; email: string; } export interface IsUserUniqueResponse { isUnique: boolean; } export interface AddHumanUserRequest { userName: string; profile: AddHumanUserRequest_Profile | undefined; email: AddHumanUserRequest_Email | undefined; phone: AddHumanUserRequest_Phone | undefined; initialPassword: string; } export interface AddHumanUserRequest_Profile { firstName: string; lastName: string; nickName: string; displayName: string; preferredLanguage: string; gender: Gender; } export interface AddHumanUserRequest_Email { email: string; isEmailVerified: boolean; } export interface AddHumanUserRequest_Phone { /** has to be a global number */ phone: string; isPhoneVerified: boolean; } export interface AddHumanUserResponse { userId: string; details: ObjectDetails | undefined; } /** Describe my Import Human User Request */ export interface ImportHumanUserRequest { userName: string; profile: ImportHumanUserRequest_Profile | undefined; email: ImportHumanUserRequest_Email | undefined; phone: ImportHumanUserRequest_Phone | undefined; password: string; hashedPassword: ImportHumanUserRequest_HashedPassword | undefined; passwordChangeRequired: boolean; requestPasswordlessRegistration: boolean; otpCode: string; idps: ImportHumanUserRequest_IDP[]; } export interface ImportHumanUserRequest_Profile { firstName: string; lastName: string; nickName: string; displayName: string; preferredLanguage: string; gender: Gender; } export interface ImportHumanUserRequest_Email { email: string; isEmailVerified: boolean; } export interface ImportHumanUserRequest_Phone { phone: string; isPhoneVerified: boolean; } export interface ImportHumanUserRequest_HashedPassword { value: string; } export interface ImportHumanUserRequest_IDP { configId: string; externalUserId: string; displayName: string; } export interface ImportHumanUserResponse { userId: string; details: ObjectDetails | undefined; passwordlessRegistration: ImportHumanUserResponse_PasswordlessRegistration | undefined; } export interface ImportHumanUserResponse_PasswordlessRegistration { link: string; /** deprecated: use expiration instead */ lifetime: Duration | undefined; expiration: Duration | undefined; } export interface AddMachineUserRequest { userName: string; name: string; description: string; accessTokenType: AccessTokenType; /** optionally set your own id unique for the user. */ userId?: string | undefined; } export interface AddMachineUserResponse { userId: string; details: ObjectDetails | undefined; } export interface DeactivateUserRequest { id: string; } export interface DeactivateUserResponse { details: ObjectDetails | undefined; } export interface ReactivateUserRequest { id: string; } export interface ReactivateUserResponse { details: ObjectDetails | undefined; } export interface LockUserRequest { id: string; } export interface LockUserResponse { details: ObjectDetails | undefined; } export interface UnlockUserRequest { id: string; } export interface UnlockUserResponse { details: ObjectDetails | undefined; } export interface RemoveUserRequest { id: string; } export interface RemoveUserResponse { details: ObjectDetails | undefined; } export interface UpdateUserNameRequest { userId: string; userName: string; } export interface UpdateUserNameResponse { details: ObjectDetails | undefined; } export interface ListUserMetadataRequest { id: string; query: ListQuery | undefined; queries: MetadataQuery[]; } export interface ListUserMetadataResponse { details: ListDetails | undefined; result: Metadata[]; } export interface GetUserMetadataRequest { id: string; key: string; } export interface GetUserMetadataResponse { metadata: Metadata | undefined; } export interface SetUserMetadataRequest { id: string; key: string; value: Buffer; } export interface SetUserMetadataResponse { id: string; details: ObjectDetails | undefined; } export interface BulkSetUserMetadataRequest { id: string; metadata: BulkSetUserMetadataRequest_Metadata[]; } export interface BulkSetUserMetadataRequest_Metadata { key: string; value: Buffer; } export interface BulkSetUserMetadataResponse { details: ObjectDetails | undefined; } export interface RemoveUserMetadataRequest { id: string; key: string; } export interface RemoveUserMetadataResponse { details: ObjectDetails | undefined; } export interface BulkRemoveUserMetadataRequest { id: string; keys: string[]; } export interface BulkRemoveUserMetadataResponse { details: ObjectDetails | undefined; } export interface GetHumanProfileRequest { userId: string; } export interface GetHumanProfileResponse { details: ObjectDetails | undefined; profile: Profile | undefined; } export interface UpdateHumanProfileRequest { userId: string; firstName: string; lastName: string; nickName: string; displayName: string; preferredLanguage: string; gender: Gender; } export interface UpdateHumanProfileResponse { details: ObjectDetails | undefined; } export interface GetHumanEmailRequest { userId: string; } export interface GetHumanEmailResponse { details: ObjectDetails | undefined; email: Email | undefined; } export interface UpdateHumanEmailRequest { userId: string; email: string; isEmailVerified: boolean; } export interface UpdateHumanEmailResponse { details: ObjectDetails | undefined; } export interface ResendHumanInitializationRequest { userId: string; email: string; } export interface ResendHumanInitializationResponse { details: ObjectDetails | undefined; } export interface ResendHumanEmailVerificationRequest { userId: string; } export interface ResendHumanEmailVerificationResponse { details: ObjectDetails | undefined; } export interface GetHumanPhoneRequest { userId: string; } export interface GetHumanPhoneResponse { details: ObjectDetails | undefined; phone: Phone | undefined; } export interface UpdateHumanPhoneRequest { userId: string; phone: string; isPhoneVerified: boolean; } export interface UpdateHumanPhoneResponse { details: ObjectDetails | undefined; } export interface RemoveHumanPhoneRequest { userId: string; } export interface RemoveHumanPhoneResponse { details: ObjectDetails | undefined; } export interface ResendHumanPhoneVerificationRequest { userId: string; } export interface ResendHumanPhoneVerificationResponse { details: ObjectDetails | undefined; } export interface RemoveHumanAvatarRequest { userId: string; } export interface RemoveHumanAvatarResponse { details: ObjectDetails | undefined; } export interface SetHumanInitialPasswordRequest { userId: string; password: string; } export interface SetHumanInitialPasswordResponse { details: ObjectDetails | undefined; } export interface SetHumanPasswordRequest { userId: string; password: string; noChangeRequired: boolean; } export interface SetHumanPasswordResponse { details: ObjectDetails | undefined; } export interface SendHumanResetPasswordNotificationRequest { userId: string; type: SendHumanResetPasswordNotificationRequest_Type; } export declare enum SendHumanResetPasswordNotificationRequest_Type { TYPE_EMAIL = 0, TYPE_SMS = 1, UNRECOGNIZED = -1 } export declare function sendHumanResetPasswordNotificationRequest_TypeFromJSON(object: any): SendHumanResetPasswordNotificationRequest_Type; export declare function sendHumanResetPasswordNotificationRequest_TypeToJSON(object: SendHumanResetPasswordNotificationRequest_Type): string; export interface SendHumanResetPasswordNotificationResponse { details: ObjectDetails | undefined; } export interface ListHumanAuthFactorsRequest { userId: string; } export interface ListHumanAuthFactorsResponse { result: AuthFactor[]; } export interface RemoveHumanAuthFactorOTPRequest { userId: string; } export interface RemoveHumanAuthFactorOTPResponse { details: ObjectDetails | undefined; } export interface RemoveHumanAuthFactorU2FRequest { userId: string; tokenId: string; } export interface RemoveHumanAuthFactorU2FResponse { details: ObjectDetails | undefined; } export interface RemoveHumanAuthFactorOTPSMSRequest { userId: string; } export interface RemoveHumanAuthFactorOTPSMSResponse { details: ObjectDetails | undefined; } export interface RemoveHumanAuthFactorOTPEmailRequest { userId: string; } export interface RemoveHumanAuthFactorOTPEmailResponse { details: ObjectDetails | undefined; } export interface ListHumanPasswordlessRequest { userId: string; } export interface ListHumanPasswordlessResponse { result: WebAuthNToken[]; } export interface AddPasswordlessRegistrationRequest { userId: string; } export interface AddPasswordlessRegistrationResponse { details: ObjectDetails | undefined; link: string; expiration: Duration | undefined; } export interface SendPasswordlessRegistrationRequest { userId: string; } export interface SendPasswordlessRegistrationResponse { details: ObjectDetails | undefined; } export interface RemoveHumanPasswordlessRequest { userId: string; tokenId: string; } export interface RemoveHumanPasswordlessResponse { details: ObjectDetails | undefined; } export interface UpdateMachineRequest { userId: string; description: string; name: string; accessTokenType: AccessTokenType; } export interface UpdateMachineResponse { details: ObjectDetails | undefined; } export interface GenerateMachineSecretRequest { userId: string; } export interface GenerateMachineSecretResponse { clientId: string; clientSecret: string; details: ObjectDetails | undefined; } export interface RemoveMachineSecretRequest { userId: string; } export interface RemoveMachineSecretResponse { details: ObjectDetails | undefined; } export interface GetMachineKeyByIDsRequest { userId: string; keyId: string; } export interface GetMachineKeyByIDsResponse { key: Key | undefined; } export interface ListMachineKeysRequest { userId: string; /** list limitations and ordering */ query: ListQuery | undefined; } export interface ListMachineKeysResponse { details: ListDetails | undefined; result: Key[]; } export interface AddMachineKeyRequest { userId: string; type: KeyType; expirationDate: Date | undefined; publicKey: Buffer; } export interface AddMachineKeyResponse { keyId: string; keyDetails: Buffer; details: ObjectDetails | undefined; } export interface RemoveMachineKeyRequest { userId: string; keyId: string; } export interface RemoveMachineKeyResponse { details: ObjectDetails | undefined; } export interface GetPersonalAccessTokenByIDsRequest { userId: string; tokenId: string; } export interface GetPersonalAccessTokenByIDsResponse { token: PersonalAccessToken | undefined; } export interface ListPersonalAccessTokensRequest { userId: string; /** list limitations and ordering */ query: ListQuery | undefined; } export interface ListPersonalAccessTokensResponse { details: ListDetails | undefined; result: PersonalAccessToken[]; } export interface AddPersonalAccessTokenRequest { userId: string; expirationDate: Date | undefined; } export interface AddPersonalAccessTokenResponse { tokenId: string; token: string; details: ObjectDetails | undefined; } export interface RemovePersonalAccessTokenRequest { userId: string; tokenId: string; } export interface RemovePersonalAccessTokenResponse { details: ObjectDetails | undefined; } export interface ListHumanLinkedIDPsRequest { userId: string; /** list limitations and ordering */ query: ListQuery | undefined; } export interface ListHumanLinkedIDPsResponse { details: ListDetails | undefined; result: IDPUserLink[]; } export interface RemoveHumanLinkedIDPRequest { userId: string; idpId: string; linkedUserId: string; } export interface RemoveHumanLinkedIDPResponse { details: ObjectDetails | undefined; } export interface ListUserMembershipsRequest { /** list limitations and ordering */ userId: string; /** the field the result is sorted */ query: ListQuery | undefined; /** criteria the client is looking for */ queries: MembershipQuery[]; } export interface ListUserMembershipsResponse { details: ListDetails | undefined; result: Membership[]; } /** This is an empty request */ export interface GetMyOrgRequest { } export interface GetMyOrgResponse { org: Org | undefined; } export interface GetOrgByDomainGlobalRequest { domain: string; } export interface ListOrgChangesRequest { /** list limitations and ordering */ query: ChangeQuery | undefined; } export interface ListOrgChangesResponse { /** zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary info) */ result: Change[]; } export interface GetOrgByDomainGlobalResponse { org: Org | undefined; } export interface AddOrgRequest { name: string; } export interface AddOrgResponse { id: string; details: ObjectDetails | undefined; } export interface UpdateOrgRequest { name: string; } export interface UpdateOrgResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface DeactivateOrgRequest { } export interface DeactivateOrgResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface ReactivateOrgRequest { } export interface ReactivateOrgResponse { details: ObjectDetails | undefined; } export interface RemoveOrgRequest { } export interface RemoveOrgResponse { details: ObjectDetails | undefined; } export interface ListOrgDomainsRequest { /** list limitations and ordering */ query: ListQuery | undefined; /** criteria the client is looking for */ queries: DomainSearchQuery[]; } export interface ListOrgDomainsResponse { details: ListDetails | undefined; result: Domain[]; } export interface AddOrgDomainRequest { domain: string; } export interface AddOrgDomainResponse { details: ObjectDetails | undefined; } export interface RemoveOrgDomainRequest { domain: string; } export interface RemoveOrgDomainResponse { details: ObjectDetails | undefined; } export interface GenerateOrgDomainValidationRequest { domain: string; type: DomainValidationType; } export interface GenerateOrgDomainValidationResponse { token: string; url: string; } export interface ValidateOrgDomainRequest { domain: string; } export interface ValidateOrgDomainResponse { details: ObjectDetails | undefined; } export interface SetPrimaryOrgDomainRequest { domain: string; } export interface SetPrimaryOrgDomainResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface ListOrgMemberRolesRequest { } export interface ListOrgMemberRolesResponse { result: string[]; } export interface ListOrgMembersRequest { /** list limitations and ordering */ query: ListQuery | undefined; /** criteria the client is looking for */ queries: SearchQuery1[]; } export interface ListOrgMembersResponse { /** list limitations and ordering */ details: ListDetails | undefined; /** criteria the client is looking for */ result: Member[]; } export interface AddOrgMemberRequest { userId: string; roles: string[]; } export interface AddOrgMemberResponse { details: ObjectDetails | undefined; } export interface UpdateOrgMemberRequest { userId: string; roles: string[]; } export interface UpdateOrgMemberResponse { details: ObjectDetails | undefined; } export interface RemoveOrgMemberRequest { userId: string; } export interface RemoveOrgMemberResponse { details: ObjectDetails | undefined; } export interface ListOrgMetadataRequest { query: ListQuery | undefined; queries: MetadataQuery[]; } export interface ListOrgMetadataResponse { details: ListDetails | undefined; result: Metadata[]; } export interface GetOrgMetadataRequest { key: string; } export interface GetOrgMetadataResponse { metadata: Metadata | undefined; } export interface SetOrgMetadataRequest { key: string; value: Buffer; } export interface SetOrgMetadataResponse { details: ObjectDetails | undefined; } export interface BulkSetOrgMetadataRequest { metadata: BulkSetOrgMetadataRequest_Metadata[]; } export interface BulkSetOrgMetadataRequest_Metadata { key: string; value: Buffer; } export interface BulkSetOrgMetadataResponse { details: ObjectDetails | undefined; } export interface RemoveOrgMetadataRequest { key: string; } export interface RemoveOrgMetadataResponse { details: ObjectDetails | undefined; } export interface BulkRemoveOrgMetadataRequest { keys: string[]; } export interface BulkRemoveOrgMetadataResponse { details: ObjectDetails | undefined; } export interface GetProjectByIDRequest { id: string; } export interface GetProjectByIDResponse { project: Project | undefined; } export interface GetGrantedProjectByIDRequest { projectId: string; grantId: string; } export interface GetGrantedProjectByIDResponse { grantedProject: GrantedProject | undefined; } export interface ListProjectsRequest { /** list limitations and ordering */ query: ListQuery | undefined; /** criteria the client is looking for */ queries: ProjectQuery[]; } export interface ListProjectsResponse { details: ListDetails | undefined; result: Project[]; } export interface ListGrantedProjectsRequest { /** list limitations and ordering */ query: ListQuery | undefined; /** criteria the client is looking for */ queries: ProjectQuery[]; } export interface ListGrantedProjectsResponse { details: ListDetails | undefined; result: GrantedProject[]; } export interface ListProjectChangesRequest { /** list limitations and ordering */ query: ChangeQuery | undefined; projectId: string; } export interface ListProjectChangesResponse { /** zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary info) */ result: Change[]; } export interface AddProjectRequest { name: string; projectRoleAssertion: boolean; projectRoleCheck: boolean; hasProjectCheck: boolean; privateLabelingSetting: PrivateLabelingSetting; } export interface AddProjectResponse { id: string; details: ObjectDetails | undefined; } export interface UpdateProjectRequest { id: string; name: string; projectRoleAssertion: boolean; projectRoleCheck: boolean; hasProjectCheck: boolean; privateLabelingSetting: PrivateLabelingSetting; } export interface UpdateProjectResponse { details: ObjectDetails | undefined; } export interface DeactivateProjectRequest { id: string; } export interface DeactivateProjectResponse { details: ObjectDetails | undefined; } export interface ReactivateProjectRequest { id: string; } export interface ReactivateProjectResponse { details: ObjectDetails | undefined; } export interface RemoveProjectRequest { id: string; } export interface RemoveProjectResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface ListProjectMemberRolesRequest { } export interface ListProjectMemberRolesResponse { details: ListDetails | undefined; result: string[]; } export interface AddProjectRoleRequest { projectId: string; roleKey: string; displayName: string; group: string; } export interface AddProjectRoleResponse { details: ObjectDetails | undefined; } export interface BulkAddProjectRolesRequest { projectId: string; roles: BulkAddProjectRolesRequest_Role[]; } export interface BulkAddProjectRolesRequest_Role { key: string; displayName: string; group: string; } export interface BulkAddProjectRolesResponse { details: ObjectDetails | undefined; } export interface UpdateProjectRoleRequest { projectId: string; roleKey: string; displayName: string; group: string; } export interface UpdateProjectRoleResponse { details: ObjectDetails | undefined; } export interface RemoveProjectRoleRequest { projectId: string; roleKey: string; } export interface RemoveProjectRoleResponse { details: ObjectDetails | undefined; } export interface ListProjectRolesRequest { projectId: string; /** list limitations and ordering */ query: ListQuery | undefined; /** criteria the client is looking for */ queries: RoleQuery[]; } export interface ListProjectRolesResponse { details: ListDetails | undefined; result: Role[]; } export interface ListGrantedProjectRolesRequest { projectId: string; grantId: string; /** list limitations and ordering */ query: ListQuery | undefined; /** criteria the client is looking for */ queries: RoleQuery[]; } export interface ListGrantedProjectRolesResponse { details: ListDetails | undefined; result: Role[]; } export interface ListProjectMembersRequest { projectId: string; /** list limitations and ordering */ query: ListQuery | undefined; /** criteria the client is looking for */ queries: SearchQuery1[]; } export interface ListProjectMembersResponse { details: ListDetails | undefined; result: Member[]; } export interface AddProjectMemberRequest { projectId: string; userId: string; roles: string[]; } export interface AddProjectMemberResponse { details: ObjectDetails | undefined; } export interface UpdateProjectMemberRequest { projectId: string; userId: string; roles: string[]; } export interface UpdateProjectMemberResponse { details: ObjectDetails | undefined; } export interface RemoveProjectMemberRequest { projectId: string; userId: string; } export interface RemoveProjectMemberResponse { details: ObjectDetails | undefined; } export interface GetAppByIDRequest { projectId: string; appId: string; } export interface GetAppByIDResponse { app: App | undefined; } export interface ListAppsRequest { projectId: string; /** list limitations and ordering */ query: ListQuery | undefined; /** criteria the client is looking for */ queries: AppQuery[]; } export interface ListAppsResponse { details: ListDetails | undefined; result: App[]; } export interface ListAppChangesRequest { /** list limitations and ordering */ query: ChangeQuery | undefined; projectId: string; appId: string; } export interface ListAppChangesResponse { /** zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary info) */ result: Change[]; } export interface AddOIDCAppRequest { projectId: string; name: string; redirectUris: string[]; responseTypes: OIDCResponseType[]; grantTypes: OIDCGrantType[]; appType: OIDCAppType; authMethodType: OIDCAuthMethodType; postLogoutRedirectUris: string[]; version: OIDCVersion; devMode: boolean; accessTokenType: OIDCTokenType; accessTokenRoleAssertion: boolean; idTokenRoleAssertion: boolean; idTokenUserinfoAssertion: boolean; clockSkew: Duration | undefined; additionalOrigins: string[]; skipNativeAppSuccessPage: boolean; } export interface AddOIDCAppResponse { appId: string; details: ObjectDetails | undefined; clientId: string; clientSecret: string; noneCompliant: boolean; complianceProblems: LocalizedMessage[]; } export interface AddSAMLAppRequest { projectId: string; name: string; metadataXml?: Buffer | undefined; metadataUrl?: string | undefined; } export interface AddSAMLAppResponse { appId: string; details: ObjectDetails | undefined; } export interface AddAPIAppRequest { projectId: string; name: string; authMethodType: APIAuthMethodType; } export interface AddAPIAppResponse { appId: string; details: ObjectDetails | undefined; clientId: string; clientSecret: string; } export interface UpdateAppRequest { projectId: string; appId: string; name: string; } export interface UpdateAppResponse { details: ObjectDetails | undefined; } export interface UpdateOIDCAppConfigRequest { projectId: string; appId: string; redirectUris: string[]; responseTypes: OIDCResponseType[]; grantTypes: OIDCGrantType[]; appType: OIDCAppType; authMethodType: OIDCAuthMethodType; postLogoutRedirectUris: string[]; devMode: boolean; accessTokenType: OIDCTokenType; accessTokenRoleAssertion: boolean; idTokenRoleAssertion: boolean; idTokenUserinfoAssertion: boolean; clockSkew: Duration | undefined; additionalOrigins: string[]; skipNativeAppSuccessPage: boolean; } export interface UpdateOIDCAppConfigResponse { details: ObjectDetails | undefined; } export interface UpdateSAMLAppConfigRequest { projectId: string; appId: string; metadataXml?: Buffer | undefined; metadataUrl?: string | undefined; } export interface UpdateSAMLAppConfigResponse { details: ObjectDetails | undefined; } export interface UpdateAPIAppConfigRequest { projectId: string; appId: string; authMethodType: APIAuthMethodType; } export interface UpdateAPIAppConfigResponse { details: ObjectDetails | undefined; } export interface DeactivateAppRequest { projectId: string; appId: string; } export interface DeactivateAppResponse { details: ObjectDetails | undefined; } export interface ReactivateAppRequest { projectId: string; appId: string; } export interface ReactivateAppResponse { details: ObjectDetails | undefined; } export interface RemoveAppRequest { projectId: string; appId: string; } export interface RemoveAppResponse { details: ObjectDetails | undefined; } export interface RegenerateOIDCClientSecretRequest { projectId: string; appId: string; } export interface RegenerateOIDCClientSecretResponse { clientSecret: string; details: ObjectDetails | undefined; } export interface RegenerateAPIClientSecretRequest { projectId: string; appId: string; } export interface RegenerateAPIClientSecretResponse { clientSecret: string; details: ObjectDetails | undefined; } export interface GetAppKeyRequest { projectId: string; appId: string; keyId: string; } export interface GetAppKeyResponse { key: Key | undefined; } export interface ListAppKeysRequest { /** list limitations and ordering */ query: ListQuery | undefined; appId: string; projectId: string; } export interface ListAppKeysResponse { details: ListDetails | undefined; result: Key[]; } export interface AddAppKeyRequest { projectId: string; appId: string; type: KeyType; expirationDate: Date | undefined; } export interface AddAppKeyResponse { id: string; details: ObjectDetails | undefined; keyDetails: Buffer; } export interface RemoveAppKeyRequest { projectId: string; appId: string; keyId: string; } export interface RemoveAppKeyResponse { details: ObjectDetails | undefined; } export interface ListProjectGrantChangesRequest { /** list limitations and ordering */ query: ChangeQuery | undefined; projectId: string; grantId: string; } export interface ListProjectGrantChangesResponse { /** zitadel.v1.ListDetails details = 1; was always returned empty (as we cannot get the necessary info) */ result: Change[]; } export interface GetProjectGrantByIDRequest { projectId: string; grantId: string; } export interface GetProjectGrantByIDResponse { projectGrant: GrantedProject | undefined; } export interface ListProjectGrantsRequest { projectId: string; /** list limitations and ordering */ query: ListQuery | undefined; /** criteria the client is looking for */ queries: ProjectGrantQuery[]; } export interface ListProjectGrantsResponse { details: ListDetails | undefined; result: GrantedProject[]; } export interface ListAllProjectGrantsRequest { /** list limitations and ordering */ query: ListQuery | undefined; /** criteria the client is looking for */ queries: AllProjectGrantQuery[]; } export interface ListAllProjectGrantsResponse { details: ListDetails | undefined; result: GrantedProject[]; } export interface AddProjectGrantRequest { projectId: string; grantedOrgId: string; roleKeys: string[]; } export interface AddProjectGrantResponse { grantId: string; details: ObjectDetails | undefined; } export interface UpdateProjectGrantRequest { projectId: string; grantId: string; roleKeys: string[]; } export interface UpdateProjectGrantResponse { details: ObjectDetails | undefined; } export interface DeactivateProjectGrantRequest { projectId: string; grantId: string; } export interface DeactivateProjectGrantResponse { details: ObjectDetails | undefined; } export interface ReactivateProjectGrantRequest { projectId: string; grantId: string; } export interface ReactivateProjectGrantResponse { details: ObjectDetails | undefined; } export interface RemoveProjectGrantRequest { projectId: string; grantId: string; } export interface RemoveProjectGrantResponse { details: ObjectDetails | undefined; } export interface ListProjectGrantMemberRolesRequest { query: ListQuery | undefined; result: string[]; } export interface ListProjectGrantMemberRolesResponse { details: ListDetails | undefined; result: string[]; } export interface ListProjectGrantMembersRequest { projectId: string; grantId: string; /** list limitations and ordering */ query: ListQuery | undefined; /** criteria the client is looking for */ queries: SearchQuery1[]; } export interface ListProjectGrantMembersResponse { details: ListDetails | undefined; result: Member[]; } export interface AddProjectGrantMemberRequest { projectId: string; grantId: string; userId: string; roles: string[]; } export interface AddProjectGrantMemberResponse { details: ObjectDetails | undefined; } export interface UpdateProjectGrantMemberRequest { projectId: string; grantId: string; userId: string; roles: string[]; } export interface UpdateProjectGrantMemberResponse { details: ObjectDetails | undefined; } export interface RemoveProjectGrantMemberRequest { projectId: string; grantId: string; userId: string; } export interface RemoveProjectGrantMemberResponse { details: ObjectDetails | undefined; } export interface GetUserGrantByIDRequest { userId: string; grantId: string; } export interface GetUserGrantByIDResponse { userGrant: UserGrant | undefined; } export interface ListUserGrantRequest { /** list limitations and ordering */ query: ListQuery | undefined; /** criteria the client is looking for */ queries: UserGrantQuery[]; } export interface ListUserGrantResponse { details: ListDetails | undefined; result: UserGrant[]; } export interface AddUserGrantRequest { userId: string; projectId: string; projectGrantId: string; roleKeys: string[]; } export interface AddUserGrantResponse { userGrantId: string; details: ObjectDetails | undefined; } export interface UpdateUserGrantRequest { userId: string; grantId: string; roleKeys: string[]; } export interface UpdateUserGrantResponse { details: ObjectDetails | undefined; } export interface DeactivateUserGrantRequest { userId: string; grantId: string; } export interface DeactivateUserGrantResponse { details: ObjectDetails | undefined; } export interface ReactivateUserGrantRequest { userId: string; grantId: string; } export interface ReactivateUserGrantResponse { details: ObjectDetails | undefined; } export interface RemoveUserGrantRequest { userId: string; grantId: string; } export interface RemoveUserGrantResponse { details: ObjectDetails | undefined; } export interface BulkRemoveUserGrantRequest { grantId: string[]; } export interface BulkRemoveUserGrantResponse { } export interface GetOrgIAMPolicyRequest { } export interface GetOrgIAMPolicyResponse { policy: OrgIAMPolicy | undefined; } export interface GetDomainPolicyRequest { } export interface GetDomainPolicyResponse { policy: DomainPolicy | undefined; } export interface GetLoginPolicyRequest { } export interface GetLoginPolicyResponse { policy: LoginPolicy | undefined; /** deprecated: is_default is also defined in zitadel.policy.v1.LoginPolicy */ isDefault: boolean; } export interface GetDefaultLoginPolicyRequest { } export interface GetDefaultLoginPolicyResponse { policy: LoginPolicy | undefined; } export interface AddCustomLoginPolicyRequest { allowUsernamePassword: boolean; allowRegister: boolean; allowExternalIdp: boolean; forceMfa: boolean; passwordlessType: PasswordlessType; hidePasswordReset: boolean; ignoreUnknownUsernames: boolean; defaultRedirectUri: string; passwordCheckLifetime: Duration | undefined; externalLoginCheckLifetime: Duration | undefined; mfaInitSkipLifetime: Duration | undefined; secondFactorCheckLifetime: Duration | undefined; multiFactorCheckLifetime: Duration | undefined; secondFactors: SecondFactorType[]; multiFactors: MultiFactorType[]; idps: AddCustomLoginPolicyRequest_IDP[]; /** If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organization on success. */ allowDomainDiscovery: boolean; disableLoginWithEmail: boolean; disableLoginWithPhone: boolean; forceMfaLocalOnly: boolean; } export interface AddCustomLoginPolicyRequest_IDP { idpId: string; ownerType: IDPOwnerType; } export interface AddCustomLoginPolicyResponse { details: ObjectDetails | undefined; } export interface UpdateCustomLoginPolicyRequest { allowUsernamePassword: boolean; allowRegister: boolean; allowExternalIdp: boolean; forceMfa: boolean; passwordlessType: PasswordlessType; hidePasswordReset: boolean; ignoreUnknownUsernames: boolean; defaultRedirectUri: string; passwordCheckLifetime: Duration | undefined; externalLoginCheckLifetime: Duration | undefined; mfaInitSkipLifetime: Duration | undefined; secondFactorCheckLifetime: Duration | undefined; multiFactorCheckLifetime: Duration | undefined; /** If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organization on success. */ allowDomainDiscovery: boolean; disableLoginWithEmail: boolean; disableLoginWithPhone: boolean; forceMfaLocalOnly: boolean; } export interface UpdateCustomLoginPolicyResponse { details: ObjectDetails | undefined; } export interface ResetLoginPolicyToDefaultRequest { } export interface ResetLoginPolicyToDefaultResponse { details: ObjectDetails | undefined; } export interface ListLoginPolicyIDPsRequest { query: ListQuery | undefined; } export interface ListLoginPolicyIDPsResponse { details: ListDetails | undefined; result: IDPLoginPolicyLink[]; } export interface AddIDPToLoginPolicyRequest { idpId: string; ownerType: IDPOwnerType; } export interface AddIDPToLoginPolicyResponse { details: ObjectDetails | undefined; } export interface RemoveIDPFromLoginPolicyRequest { idpId: string; } export interface RemoveIDPFromLoginPolicyResponse { details: ObjectDetails | undefined; } export interface ListLoginPolicySecondFactorsRequest { } export interface ListLoginPolicySecondFactorsResponse { details: ListDetails | undefined; result: SecondFactorType[]; } export interface AddSecondFactorToLoginPolicyRequest { type: SecondFactorType; } export interface AddSecondFactorToLoginPolicyResponse { details: ObjectDetails | undefined; } export interface RemoveSecondFactorFromLoginPolicyRequest { type: SecondFactorType; } export interface RemoveSecondFactorFromLoginPolicyResponse { details: ObjectDetails | undefined; } export interface ListLoginPolicyMultiFactorsRequest { } export interface ListLoginPolicyMultiFactorsResponse { details: ListDetails | undefined; result: MultiFactorType[]; } export interface AddMultiFactorToLoginPolicyRequest { type: MultiFactorType; } export interface AddMultiFactorToLoginPolicyResponse { details: ObjectDetails | undefined; } export interface RemoveMultiFactorFromLoginPolicyRequest { type: MultiFactorType; } export interface RemoveMultiFactorFromLoginPolicyResponse { details: ObjectDetails | undefined; } export interface GetPasswordComplexityPolicyRequest { } export interface GetPasswordComplexityPolicyResponse { policy: PasswordComplexityPolicy | undefined; /** deprecated: is_default is also defined in zitadel.policy.v1.PasswordComplexityPolicy */ isDefault: boolean; } /** This is an empty request */ export interface GetDefaultPasswordComplexityPolicyRequest { } export interface GetDefaultPasswordComplexityPolicyResponse { policy: PasswordComplexityPolicy | undefined; } export interface AddCustomPasswordComplexityPolicyRequest { minLength: Long; hasUppercase: boolean; hasLowercase: boolean; hasNumber: boolean; hasSymbol: boolean; } export interface AddCustomPasswordComplexityPolicyResponse { details: ObjectDetails | undefined; } export interface UpdateCustomPasswordComplexityPolicyRequest { minLength: Long; hasUppercase: boolean; hasLowercase: boolean; hasNumber: boolean; hasSymbol: boolean; } export interface UpdateCustomPasswordComplexityPolicyResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface ResetPasswordComplexityPolicyToDefaultRequest { } export interface ResetPasswordComplexityPolicyToDefaultResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface GetPasswordAgePolicyRequest { } export interface GetPasswordAgePolicyResponse { policy: PasswordAgePolicy | undefined; /** deprecated: is_default is also defined in zitadel.policy.v1.PasswordAgePolicy */ isDefault: boolean; } /** This is an empty request */ export interface GetDefaultPasswordAgePolicyRequest { } export interface GetDefaultPasswordAgePolicyResponse { policy: PasswordAgePolicy | undefined; } export interface AddCustomPasswordAgePolicyRequest { /** Amount of days after which a password will expire. The user will be forced to change the password on the following authentication. */ maxAgeDays: number; /** Amount of days after which the user should be notified of the upcoming expiry. ZITADEL will not notify the user. */ expireWarnDays: number; } export interface AddCustomPasswordAgePolicyResponse { details: ObjectDetails | undefined; } export interface UpdateCustomPasswordAgePolicyRequest { /** Amount of days after which a password will expire. The user will be forced to change the password on the following authentication. */ maxAgeDays: number; /** Amount of days after which the user should be notified of the upcoming expiry. ZITADEL will not notify the user. */ expireWarnDays: number; } export interface UpdateCustomPasswordAgePolicyResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface ResetPasswordAgePolicyToDefaultRequest { } export interface ResetPasswordAgePolicyToDefaultResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface GetLockoutPolicyRequest { } export interface GetLockoutPolicyResponse { policy: LockoutPolicy | undefined; /** deprecated: is_default is also defined in zitadel.policy.v1.LockoutPolicy */ isDefault: boolean; } /** This is an empty request */ export interface GetDefaultLockoutPolicyRequest { } export interface GetDefaultLockoutPolicyResponse { policy: LockoutPolicy | undefined; } export interface AddCustomLockoutPolicyRequest { maxPasswordAttempts: number; maxOtpAttempts: number; } export interface AddCustomLockoutPolicyResponse { details: ObjectDetails | undefined; } export interface UpdateCustomLockoutPolicyRequest { maxPasswordAttempts: number; maxOtpAttempts: number; } export interface UpdateCustomLockoutPolicyResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface ResetLockoutPolicyToDefaultRequest { } export interface ResetLockoutPolicyToDefaultResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface GetPrivacyPolicyRequest { } export interface GetPrivacyPolicyResponse { policy: PrivacyPolicy | undefined; } /** This is an empty request */ export interface GetDefaultPrivacyPolicyRequest { } export interface GetDefaultPrivacyPolicyResponse { policy: PrivacyPolicy | undefined; } export interface AddCustomPrivacyPolicyRequest { tosLink: string; privacyLink: string; helpLink: string; supportEmail: string; docsLink: string; customLink: string; customLinkText: string; } export interface AddCustomPrivacyPolicyResponse { details: ObjectDetails | undefined; } export interface UpdateCustomPrivacyPolicyRequest { tosLink: string; privacyLink: string; helpLink: string; supportEmail: string; docsLink: string; customLink: string; customLinkText: string; } export interface UpdateCustomPrivacyPolicyResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface ResetPrivacyPolicyToDefaultRequest { } export interface ResetPrivacyPolicyToDefaultResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface GetNotificationPolicyRequest { } export interface GetNotificationPolicyResponse { policy: NotificationPolicy | undefined; } /** This is an empty request */ export interface GetDefaultNotificationPolicyRequest { } export interface GetDefaultNotificationPolicyResponse { policy: NotificationPolicy | undefined; } export interface AddCustomNotificationPolicyRequest { passwordChange: boolean; } export interface AddCustomNotificationPolicyResponse { details: ObjectDetails | undefined; } export interface UpdateCustomNotificationPolicyRequest { passwordChange: boolean; } export interface UpdateCustomNotificationPolicyResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface ResetNotificationPolicyToDefaultRequest { } export interface ResetNotificationPolicyToDefaultResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface GetLabelPolicyRequest { } export interface GetLabelPolicyResponse { policy: LabelPolicy | undefined; /** deprecated: is_default is also defined in zitadel.policy.v1.LabelPolicy */ isDefault: boolean; } /** This is an empty request */ export interface GetPreviewLabelPolicyRequest { } export interface GetPreviewLabelPolicyResponse { policy: LabelPolicy | undefined; /** deprecated: is_default is also defined in zitadel.policy.v1.LabelPolicy */ isDefault: boolean; } /** This is an empty request */ export interface GetDefaultLabelPolicyRequest { } export interface GetDefaultLabelPolicyResponse { policy: LabelPolicy | undefined; } export interface AddCustomLabelPolicyRequest { primaryColor: string; /** hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set */ hideLoginNameSuffix: boolean; warnColor: string; backgroundColor: string; fontColor: string; primaryColorDark: string; backgroundColorDark: string; warnColorDark: string; fontColorDark: string; disableWatermark: boolean; themeMode: ThemeMode; } export interface AddCustomLabelPolicyResponse { details: ObjectDetails | undefined; } export interface UpdateCustomLabelPolicyRequest { primaryColor: string; hideLoginNameSuffix: boolean; warnColor: string; backgroundColor: string; fontColor: string; primaryColorDark: string; backgroundColorDark: string; warnColorDark: string; fontColorDark: string; disableWatermark: boolean; themeMode: ThemeMode; } export interface UpdateCustomLabelPolicyResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface ActivateCustomLabelPolicyRequest { } export interface ActivateCustomLabelPolicyResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface RemoveCustomLabelPolicyLogoRequest { } export interface RemoveCustomLabelPolicyLogoResponse { details: ObjectDetails | undefined; } /** This is an empty request */ export interface RemoveCustomLabelPolicyLogoDarkRequest { } export interface RemoveCustomLabelPolicyLogoDarkResponse { details: ObjectDetails | undefined; } /** This is an empty request */ ex