@structured-id/ui-core 1.2.0 → 1.3.0

package/src/generated/sid/v1/admin/provisioning.client.ts

@@ -0,0 +1,232 @@
+// @generated by protobuf-ts 2.11.1 with parameter client_generic,generate_dependencies
+// @generated from protobuf file "sid/v1/admin/provisioning.proto" (package "sid.v1.admin", syntax proto3)
+// tslint:disable
+import type { RpcTransport } from "@protobuf-ts/runtime-rpc";
+import type { ServiceInfo } from "@protobuf-ts/runtime-rpc";
+import { ProvisioningService } from "./provisioning";
+import type { Empty } from "../../../google/protobuf/empty";
+import type { RevokeConnectorCredentialRequest } from "./provisioning";
+import type { RotateConnectorCredentialRequest } from "./provisioning";
+import type { IssuedConnectorCredential } from "./provisioning";
+import type { CreateConnectorCredentialRequest } from "./provisioning";
+import type { ListConnectorCredentialsResponse } from "./provisioning";
+import type { ListConnectorCredentialsRequest } from "./provisioning";
+import type { ScimInboundConfig } from "./provisioning";
+import type { GetScimInboundConfigRequest } from "./provisioning";
+import type { ChangeProvisioningConnectorStateRequest } from "./provisioning";
+import type { RenameProvisioningConnectorRequest } from "./provisioning";
+import type { GetProvisioningConnectorRequest } from "./provisioning";
+import type { ProvisioningConnector } from "./provisioning";
+import type { CreateInboundConnectorRequest } from "./provisioning";
+import { stackIntercept } from "@protobuf-ts/runtime-rpc";
+import type { ListProvisioningConnectorsResponse } from "./provisioning";
+import type { ListProvisioningConnectorsRequest } from "./provisioning";
+import type { UnaryCall } from "@protobuf-ts/runtime-rpc";
+import type { RpcOptions } from "@protobuf-ts/runtime-rpc";
+/**
+ * ProvisioningService manages provisioning connectors and their credentials.
+ *
+ * ── Connectors ──
+ *
+ * @generated from protobuf service sid.v1.admin.ProvisioningService
+ */
+export interface IProvisioningServiceClient {
+    /**
+     * Every connector of the organization, retired ones included, newest first.
+     *
+     * @generated from protobuf rpc: ListProvisioningConnectors
+     */
+    listProvisioningConnectors(input: ListProvisioningConnectorsRequest, options?: RpcOptions): UnaryCall<ListProvisioningConnectorsRequest, ListProvisioningConnectorsResponse>;
+    /**
+     * Register an inbound connector: a directory source that will send SCIM to
+     * this organization. It starts active, with no credential and no grant.
+     * Keyed: a retry with the same idempotency key returns the connector the
+     * first attempt created.
+     *
+     * @generated from protobuf rpc: CreateInboundConnector
+     */
+    createInboundConnector(input: CreateInboundConnectorRequest, options?: RpcOptions): UnaryCall<CreateInboundConnectorRequest, ProvisioningConnector>;
+    /**
+     * @generated from protobuf rpc: GetProvisioningConnector
+     */
+    getProvisioningConnector(input: GetProvisioningConnectorRequest, options?: RpcOptions): UnaryCall<GetProvisioningConnectorRequest, ProvisioningConnector>;
+    /**
+     * Rename a connector still at `revision`; its identity and credentials stay.
+     * A changed connector is ABORTED (CONCURRENT_MODIFICATION), a retired one
+     * FAILED_PRECONDITION.
+     *
+     * @generated from protobuf rpc: RenameProvisioningConnector
+     */
+    renameProvisioningConnector(input: RenameProvisioningConnectorRequest, options?: RpcOptions): UnaryCall<RenameProvisioningConnectorRequest, ProvisioningConnector>;
+    /**
+     * Disable, enable again, or retire a connector. Disabling stops every
+     * request of it at once, its credentials kept; it deactivates no user.
+     * Retiring is final and revokes its credentials. A step that is no
+     * lifecycle transition is FAILED_PRECONDITION; moving to the state it
+     * already has returns it unchanged.
+     *
+     * @generated from protobuf rpc: ChangeProvisioningConnectorState
+     */
+    changeProvisioningConnectorState(input: ChangeProvisioningConnectorStateRequest, options?: RpcOptions): UnaryCall<ChangeProvisioningConnectorStateRequest, ProvisioningConnector>;
+    /**
+     * What an inbound connector's SCIM client is configured with.
+     *
+     * @generated from protobuf rpc: GetScimInboundConfig
+     */
+    getScimInboundConfig(input: GetScimInboundConfigRequest, options?: RpcOptions): UnaryCall<GetScimInboundConfigRequest, ScimInboundConfig>;
+    // ── Credentials of an inbound connector ──
+
+    /**
+     * A connector's credentials, revoked ones included: metadata only.
+     *
+     * @generated from protobuf rpc: ListConnectorCredentials
+     */
+    listConnectorCredentials(input: ListConnectorCredentialsRequest, options?: RpcOptions): UnaryCall<ListConnectorCredentialsRequest, ListConnectorCredentialsResponse>;
+    /**
+     * Issue a credential of an active inbound connector; the secret is in the
+     * response only. A connector holds at most two usable credentials
+     * (RESOURCE_EXHAUSTED beyond). Keyed: a retry with the same idempotency
+     * key returns the credential the first attempt created, without its
+     * secret; a lost secret is replaced through RotateConnectorCredential.
+     *
+     * @generated from protobuf rpc: CreateConnectorCredential
+     */
+    createConnectorCredential(input: CreateConnectorCredentialRequest, options?: RpcOptions): UnaryCall<CreateConnectorCredentialRequest, IssuedConnectorCredential>;
+    /**
+     * Replace an active credential: a new one is issued (its secret in the
+     * response only) and the old one keeps working for the rotation grace
+     * period, so the client can switch without an outage. Keyed like
+     * CreateConnectorCredential.
+     *
+     * @generated from protobuf rpc: RotateConnectorCredential
+     */
+    rotateConnectorCredential(input: RotateConnectorCredentialRequest, options?: RpcOptions): UnaryCall<RotateConnectorCredentialRequest, IssuedConnectorCredential>;
+    /**
+     * Revoke a credential at once, with no grace. Revoking one already
+     * revoked is a no-op.
+     *
+     * @generated from protobuf rpc: RevokeConnectorCredential
+     */
+    revokeConnectorCredential(input: RevokeConnectorCredentialRequest, options?: RpcOptions): UnaryCall<RevokeConnectorCredentialRequest, Empty>;
+}
+/**
+ * ProvisioningService manages provisioning connectors and their credentials.
+ *
+ * ── Connectors ──
+ *
+ * @generated from protobuf service sid.v1.admin.ProvisioningService
+ */
+export class ProvisioningServiceClient implements IProvisioningServiceClient, ServiceInfo {
+    typeName = ProvisioningService.typeName;
+    methods = ProvisioningService.methods;
+    options = ProvisioningService.options;
+    constructor(private readonly _transport: RpcTransport) {
+    }
+    /**
+     * Every connector of the organization, retired ones included, newest first.
+     *
+     * @generated from protobuf rpc: ListProvisioningConnectors
+     */
+    listProvisioningConnectors(input: ListProvisioningConnectorsRequest, options?: RpcOptions): UnaryCall<ListProvisioningConnectorsRequest, ListProvisioningConnectorsResponse> {
+        const method = this.methods[0], opt = this._transport.mergeOptions(options);
+        return stackIntercept<ListProvisioningConnectorsRequest, ListProvisioningConnectorsResponse>("unary", this._transport, method, opt, input);
+    }
+    /**
+     * Register an inbound connector: a directory source that will send SCIM to
+     * this organization. It starts active, with no credential and no grant.
+     * Keyed: a retry with the same idempotency key returns the connector the
+     * first attempt created.
+     *
+     * @generated from protobuf rpc: CreateInboundConnector
+     */
+    createInboundConnector(input: CreateInboundConnectorRequest, options?: RpcOptions): UnaryCall<CreateInboundConnectorRequest, ProvisioningConnector> {
+        const method = this.methods[1], opt = this._transport.mergeOptions(options);
+        return stackIntercept<CreateInboundConnectorRequest, ProvisioningConnector>("unary", this._transport, method, opt, input);
+    }
+    /**
+     * @generated from protobuf rpc: GetProvisioningConnector
+     */
+    getProvisioningConnector(input: GetProvisioningConnectorRequest, options?: RpcOptions): UnaryCall<GetProvisioningConnectorRequest, ProvisioningConnector> {
+        const method = this.methods[2], opt = this._transport.mergeOptions(options);
+        return stackIntercept<GetProvisioningConnectorRequest, ProvisioningConnector>("unary", this._transport, method, opt, input);
+    }
+    /**
+     * Rename a connector still at `revision`; its identity and credentials stay.
+     * A changed connector is ABORTED (CONCURRENT_MODIFICATION), a retired one
+     * FAILED_PRECONDITION.
+     *
+     * @generated from protobuf rpc: RenameProvisioningConnector
+     */
+    renameProvisioningConnector(input: RenameProvisioningConnectorRequest, options?: RpcOptions): UnaryCall<RenameProvisioningConnectorRequest, ProvisioningConnector> {
+        const method = this.methods[3], opt = this._transport.mergeOptions(options);
+        return stackIntercept<RenameProvisioningConnectorRequest, ProvisioningConnector>("unary", this._transport, method, opt, input);
+    }
+    /**
+     * Disable, enable again, or retire a connector. Disabling stops every
+     * request of it at once, its credentials kept; it deactivates no user.
+     * Retiring is final and revokes its credentials. A step that is no
+     * lifecycle transition is FAILED_PRECONDITION; moving to the state it
+     * already has returns it unchanged.
+     *
+     * @generated from protobuf rpc: ChangeProvisioningConnectorState
+     */
+    changeProvisioningConnectorState(input: ChangeProvisioningConnectorStateRequest, options?: RpcOptions): UnaryCall<ChangeProvisioningConnectorStateRequest, ProvisioningConnector> {
+        const method = this.methods[4], opt = this._transport.mergeOptions(options);
+        return stackIntercept<ChangeProvisioningConnectorStateRequest, ProvisioningConnector>("unary", this._transport, method, opt, input);
+    }
+    /**
+     * What an inbound connector's SCIM client is configured with.
+     *
+     * @generated from protobuf rpc: GetScimInboundConfig
+     */
+    getScimInboundConfig(input: GetScimInboundConfigRequest, options?: RpcOptions): UnaryCall<GetScimInboundConfigRequest, ScimInboundConfig> {
+        const method = this.methods[5], opt = this._transport.mergeOptions(options);
+        return stackIntercept<GetScimInboundConfigRequest, ScimInboundConfig>("unary", this._transport, method, opt, input);
+    }
+    // ── Credentials of an inbound connector ──
+
+    /**
+     * A connector's credentials, revoked ones included: metadata only.
+     *
+     * @generated from protobuf rpc: ListConnectorCredentials
+     */
+    listConnectorCredentials(input: ListConnectorCredentialsRequest, options?: RpcOptions): UnaryCall<ListConnectorCredentialsRequest, ListConnectorCredentialsResponse> {
+        const method = this.methods[6], opt = this._transport.mergeOptions(options);
+        return stackIntercept<ListConnectorCredentialsRequest, ListConnectorCredentialsResponse>("unary", this._transport, method, opt, input);
+    }
+    /**
+     * Issue a credential of an active inbound connector; the secret is in the
+     * response only. A connector holds at most two usable credentials
+     * (RESOURCE_EXHAUSTED beyond). Keyed: a retry with the same idempotency
+     * key returns the credential the first attempt created, without its
+     * secret; a lost secret is replaced through RotateConnectorCredential.
+     *
+     * @generated from protobuf rpc: CreateConnectorCredential
+     */
+    createConnectorCredential(input: CreateConnectorCredentialRequest, options?: RpcOptions): UnaryCall<CreateConnectorCredentialRequest, IssuedConnectorCredential> {
+        const method = this.methods[7], opt = this._transport.mergeOptions(options);
+        return stackIntercept<CreateConnectorCredentialRequest, IssuedConnectorCredential>("unary", this._transport, method, opt, input);
+    }
+    /**
+     * Replace an active credential: a new one is issued (its secret in the
+     * response only) and the old one keeps working for the rotation grace
+     * period, so the client can switch without an outage. Keyed like
+     * CreateConnectorCredential.
+     *
+     * @generated from protobuf rpc: RotateConnectorCredential
+     */
+    rotateConnectorCredential(input: RotateConnectorCredentialRequest, options?: RpcOptions): UnaryCall<RotateConnectorCredentialRequest, IssuedConnectorCredential> {
+        const method = this.methods[8], opt = this._transport.mergeOptions(options);
+        return stackIntercept<RotateConnectorCredentialRequest, IssuedConnectorCredential>("unary", this._transport, method, opt, input);
+    }
+    /**
+     * Revoke a credential at once, with no grace. Revoking one already
+     * revoked is a no-op.
+     *
+     * @generated from protobuf rpc: RevokeConnectorCredential
+     */
+    revokeConnectorCredential(input: RevokeConnectorCredentialRequest, options?: RpcOptions): UnaryCall<RevokeConnectorCredentialRequest, Empty> {
+        const method = this.methods[9], opt = this._transport.mergeOptions(options);
+        return stackIntercept<RevokeConnectorCredentialRequest, Empty>("unary", this._transport, method, opt, input);
+    }
+}