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

62 lines (61 loc) 3.91 kB
import { ClientMiddleware } from 'nice-grpc'; import { AdminServiceClient } from './generated/zitadel/admin'; import { AuthServiceClient } from './generated/zitadel/auth'; import { ManagementServiceClient } from './generated/zitadel/management'; import { UserServiceClient } from './generated/zitadel/user/v2/user_service'; import { OrganizationServiceClient } from './generated/zitadel/org/v2/org_service'; /** * Create a new gRPC service client for the [Admin API](https://docs.zitadel.com/docs/apis/proto/admin) of ZITADEL. * The client can be configured with multiple client interceptors. For authentication interceptors, * see the interceptors in this package. * * @param apiEndpoint The API endpoint of your ZITADEL instance. * @param interceptors A list of interceptors that should be used for the client. * * @returns A new gRPC service client for the [Admin API](https://docs.zitadel.com/docs/apis/proto/admin) of ZITADEL. */ export declare function createAdminClient(apiEndpoint: string, ...interceptors: ClientMiddleware[]): AdminServiceClient; /** * Create a new gRPC service client for the [Auth API](https://docs.zitadel.com/docs/apis/proto/auth) of ZITADEL. * The client can be configured with multiple client interceptors. For authentication interceptors, * see the interceptors in this package. * * @param apiEndpoint The API endpoint of your ZITADEL instance. * @param interceptors A list of interceptors that should be used for the client. * * @returns A new gRPC service client for the [Auth API](https://docs.zitadel.com/docs/apis/proto/auth) of ZITADEL. */ export declare function createAuthClient(apiEndpoint: string, ...interceptors: ClientMiddleware[]): AuthServiceClient; /** * Create a new gRPC service client for the [Management API](https://docs.zitadel.com/docs/apis/proto/management) of ZITADEL. * The client can be configured with multiple client interceptors. For authentication interceptors, * see the interceptors in this package. * * @param apiEndpoint The API endpoint of your ZITADEL instance. * @param interceptors A list of interceptors that should be used for the client. * * @returns A new gRPC service client for the [Management API](https://docs.zitadel.com/docs/apis/proto/management) of ZITADEL. */ export declare function createManagementClient(apiEndpoint: string, ...interceptors: ClientMiddleware[]): ManagementServiceClient; /** * Create a new gRPC service client for the [UserService V2 API](https://zitadel.com/docs/apis/resources/user_service_v2/user-service) of ZITADEL. * The client can be configured with multiple client interceptors. For authentication interceptors, * see the interceptors in this package. * * @param apiEndpoint The API endpoint of your ZITADEL instance. * @param interceptors A list of interceptors that should be used for the client. * * @returns A new gRPC service client for the [UserService V2 API](https://zitadel.com/docs/apis/resources/user_service_v2/user-service) of ZITADEL. */ export declare function createUserClientV2(apiEndpoint: string, ...interceptors: ClientMiddleware[]): UserServiceClient; /** * Create a new gRPC service client for the [OrganizationService V2 API](https://zitadel.com/docs/apis/resources/organization_service_v2/organization-service) of ZITADEL. * The client can be configured with multiple client interceptors. For authentication interceptors, * see the interceptors in this package. * * @param apiEndpoint The API endpoint of your ZITADEL instance. * @param interceptors A list of interceptors that should be used for the client. * * @returns A new gRPC service client for the [OrganizationService V2 API](https://zitadel.com/docs/apis/resources/organization_service_v2/organization-service) of ZITADEL. */ export declare function createOrganizationClientV2(apiEndpoint: string, ...interceptors: ClientMiddleware[]): OrganizationServiceClient;