api/clients library
Library with helper methods to access the ZITADEL API itself.
Enables the creation of gRPC service clients for admin, auth, and
management APIs of ZITADEL and provides MetadataProviders to
authenticate the clients against ZITADEL.
Functions
-
accessTokenProvider(
String accessToken) → MetadataProvider -
Metadata provider that attaches a given
accessTokento any request a client sends. The token is attached with theBearerauth-scheme. -
createAdminClient(
String apiEndpoint, {int port = 443, Map< String, String> ? metadata, Iterable<MetadataProvider> ? metadataProviders, Iterable<ClientInterceptor> ? interceptors}) → AdminServiceClient - Create a new AdminServiceClient to access the Admin API of ZITADEL.
-
createAuthClient(
String apiEndpoint, {int port = 443, Map< String, String> ? metadata, Iterable<MetadataProvider> ? metadataProviders, Iterable<ClientInterceptor> ? interceptors}) → AuthServiceClient - Create a new AuthServiceClient to access the Auth API of ZITADEL.
-
createManagementClient(
String apiEndpoint, {int port = 443, Map< String, String> ? metadata, Iterable<MetadataProvider> ? metadataProviders, Iterable<ClientInterceptor> ? interceptors}) → ManagementServiceClient - Create a new ManagementServiceClient to access the Management API of ZITADEL.
-
createOIDCClient(
String apiEndpoint, {int port = 443, Map< String, String> ? metadata, Iterable<MetadataProvider> ? metadataProviders, Iterable<ClientInterceptor> ? interceptors}) → OIDCServiceClient - Create a new OIDCServiceClient to access the OIDC API of ZITADEL.
-
createOrganizationClient(
String apiEndpoint, {int port = 443, Map< String, String> ? metadata, Iterable<MetadataProvider> ? metadataProviders, Iterable<ClientInterceptor> ? interceptors}) → OrganizationServiceClient - Create a new OrganizationServiceClient to access the Organization API of ZITADEL.
-
createSessionClient(
String apiEndpoint, {int port = 443, Map< String, String> ? metadata, Iterable<MetadataProvider> ? metadataProviders, Iterable<ClientInterceptor> ? interceptors}) → SessionServiceClient - Create a new SessionServiceClient to access the Session API of ZITADEL.
-
createSettingsClient(
String apiEndpoint, {int port = 443, Map< String, String> ? metadata, Iterable<MetadataProvider> ? metadataProviders, Iterable<ClientInterceptor> ? interceptors}) → SettingsServiceClient - Create a new SettingsServiceClient to access the Settings API of ZITADEL.
-
createSystemClient(
String apiEndpoint, {int port = 443, Map< String, String> ? metadata, Iterable<MetadataProvider> ? metadataProviders, Iterable<ClientInterceptor> ? interceptors}) → SystemServiceClient - Create a new SystemServiceClient to access the System API of ZITADEL.
-
createUserClient(
String apiEndpoint, {int port = 443, Map< String, String> ? metadata, Iterable<MetadataProvider> ? metadataProviders, Iterable<ClientInterceptor> ? interceptors}) → UserServiceClient - Create a new UserServiceClient to access the User API of ZITADEL.
-
serviceAccountProvider(
String audience, ServiceAccount serviceAccount, [AuthenticationOptions? options]) → MetadataProvider - Metadata provider that authenticates the service client calls with a given ServiceAccount.