@augstash/sdk 0.2.0 → 0.3.0

package/dist/generated/src/apis/ScimGroupApi.js

@@ -0,0 +1,312 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScimGroupApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class ScimGroupApi extends runtime.BaseAPI {
+    /**
+     * Writes < 500ms. displayName is matched (case-insensitively) against this workspace\'s role names; a match makes the group grant that role to every sub-user member, no match stores it unmapped. Members that are not users of this workspace are dropped rather than stored. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: create a group
+     */
+    async createScimV2Raw(requestParameters, initOverrides) {
+        if (requestParameters['scimGroupResource'] == null) {
+            throw new runtime.RequiredError('scimGroupResource', 'Required parameter "scimGroupResource" was null or undefined when calling createScimV2().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/scim+json';
+        if (requestParameters['xIdempotencyKey'] != null) {
+            headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/scim/v2/Groups`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.ScimGroupResourceToJSON)(requestParameters['scimGroupResource']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScimGroupResourceFromJSON)(jsonValue));
+    }
+    /**
+     * Writes < 500ms. displayName is matched (case-insensitively) against this workspace\'s role names; a match makes the group grant that role to every sub-user member, no match stores it unmapped. Members that are not users of this workspace are dropped rather than stored. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: create a group
+     */
+    async createScimV2(requestParameters, initOverrides) {
+        const response = await this.createScimV2Raw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Writes < 300ms. Removes the mapping row. Members keep whatever role they hold — a deleted group is not a demotion; remove the members first if it should be. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: delete a group
+     */
+    async deleteScimV2Raw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteScimV2().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['xIdempotencyKey'] != null) {
+            headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/scim/v2/Groups/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Writes < 300ms. Removes the mapping row. Members keep whatever role they hold — a deleted group is not a demotion; remove the members first if it should be. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: delete a group
+     */
+    async deleteScimV2(requestParameters, initOverrides) {
+        await this.deleteScimV2Raw(requestParameters, initOverrides);
+    }
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: get a group
+     */
+    async getScimV2Raw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getScimV2().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/scim/v2/Groups/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScimGroupResourceFromJSON)(jsonValue));
+    }
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: get a group
+     */
+    async getScimV2(requestParameters, initOverrides) {
+        const response = await this.getScimV2Raw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Reads < 300ms. Supports filter=displayName eq \"…\", externalId eq \"…\" and id eq \"…\", plus startIndex / count paging (max 200) with no filter. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: list or filter groups
+     */
+    async listScimV2Raw(requestParameters, initOverrides) {
+        const queryParameters = {};
+        if (requestParameters['filter'] != null) {
+            queryParameters['filter'] = requestParameters['filter'];
+        }
+        if (requestParameters['startIndex'] != null) {
+            queryParameters['startIndex'] = requestParameters['startIndex'];
+        }
+        if (requestParameters['count'] != null) {
+            queryParameters['count'] = requestParameters['count'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/scim/v2/Groups`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListResponseScimGroupResourceFromJSON)(jsonValue));
+    }
+    /**
+     * Reads < 300ms. Supports filter=displayName eq \"…\", externalId eq \"…\" and id eq \"…\", plus startIndex / count paging (max 200) with no filter. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: list or filter groups
+     */
+    async listScimV2(requestParameters = {}, initOverrides) {
+        const response = await this.listScimV2Raw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Writes < 500ms. members add / remove / replace (pathless, path=members, or members[value eq \"<id>\"]), displayName and externalId replace. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: patch a group
+     */
+    async patchScimV2Raw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling patchScimV2().');
+        }
+        if (requestParameters['patchRequest'] == null) {
+            throw new runtime.RequiredError('patchRequest', 'Required parameter "patchRequest" was null or undefined when calling patchScimV2().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/scim+json';
+        if (requestParameters['xIdempotencyKey'] != null) {
+            headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/scim/v2/Groups/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.PatchRequestToJSON)(requestParameters['patchRequest']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScimGroupResourceFromJSON)(jsonValue));
+    }
+    /**
+     * Writes < 500ms. members add / remove / replace (pathless, path=members, or members[value eq \"<id>\"]), displayName and externalId replace. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: patch a group
+     */
+    async patchScimV2(requestParameters, initOverrides) {
+        const response = await this.patchScimV2Raw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Writes < 500ms. Name, externalId and the whole member list. Joiners gain the mapped role, leavers lose it if it was the one this group granted. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: replace a group
+     */
+    async replaceScimV2Raw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling replaceScimV2().');
+        }
+        if (requestParameters['scimGroupResource'] == null) {
+            throw new runtime.RequiredError('scimGroupResource', 'Required parameter "scimGroupResource" was null or undefined when calling replaceScimV2().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/scim+json';
+        if (requestParameters['xIdempotencyKey'] != null) {
+            headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/scim/v2/Groups/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.ScimGroupResourceToJSON)(requestParameters['scimGroupResource']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScimGroupResourceFromJSON)(jsonValue));
+    }
+    /**
+     * Writes < 500ms. Name, externalId and the whole member list. Joiners gain the mapped role, leavers lose it if it was the one this group granted. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: replace a group
+     */
+    async replaceScimV2(requestParameters, initOverrides) {
+        const response = await this.replaceScimV2Raw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+exports.ScimGroupApi = ScimGroupApi;

package/dist/generated/src/apis/ScimUserApi.d.ts

@@ -0,0 +1,204 @@
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { ListResponseScimUserResource, PatchRequest, ScimUserResource } from '../models/index';
+export interface CreateScimRequest {
+    scimUserResource: ScimUserResource;
+    xIdempotencyKey?: string;
+}
+export interface DeleteScimRequest {
+    id: string;
+    xIdempotencyKey?: string;
+}
+export interface GetScimRequest {
+    id: string;
+}
+export interface ListScimRequest {
+    filter?: string;
+    startIndex?: number;
+    count?: number;
+}
+export interface PatchScimRequest {
+    id: string;
+    patchRequest: PatchRequest;
+    xIdempotencyKey?: string;
+}
+export interface ReplaceScimRequest {
+    id: string;
+    scimUserResource: ScimUserResource;
+    xIdempotencyKey?: string;
+}
+/**
+ * ScimUserApi - interface
+ *
+ * @export
+ * @interface ScimUserApiInterface
+ */
+export interface ScimUserApiInterface {
+    /**
+     * Writes < 300ms. userName must be an email (or emails[] must carry one). The user is created passwordless, provider SAML, with the connection\'s default role; active=false creates them already deactivated. An email that exists anywhere — this workspace or another — is 409 uniqueness. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary SCIM: create a user
+     * @param {ScimUserResource} scimUserResource
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScimUserApiInterface
+     */
+    createScimRaw(requestParameters: CreateScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimUserResource>>;
+    /**
+     * Writes < 300ms. userName must be an email (or emails[] must carry one). The user is created passwordless, provider SAML, with the connection\'s default role; active=false creates them already deactivated. An email that exists anywhere — this workspace or another — is 409 uniqueness. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: create a user
+     */
+    createScim(requestParameters: CreateScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimUserResource>;
+    /**
+     * Writes < 300ms. Deactivates (status INACTIVE) rather than erasing: sign-in and token refresh are refused from now on, and everything the person did stays attributed to them. Erasure is a governed act with its own retention rules (governance.deletion), never a side effect of a directory sync. Idempotent. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary SCIM: deprovision a user
+     * @param {string} id
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScimUserApiInterface
+     */
+    deleteScimRaw(requestParameters: DeleteScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Writes < 300ms. Deactivates (status INACTIVE) rather than erasing: sign-in and token refresh are refused from now on, and everything the person did stays attributed to them. Erasure is a governed act with its own retention rules (governance.deletion), never a side effect of a directory sync. Idempotent. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: deprovision a user
+     */
+    deleteScim(requestParameters: DeleteScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary SCIM: get a user
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScimUserApiInterface
+     */
+    getScimRaw(requestParameters: GetScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimUserResource>>;
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: get a user
+     */
+    getScim(requestParameters: GetScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimUserResource>;
+    /**
+     * Reads < 300ms. Supports filter=userName eq \"…\", externalId eq \"…\" and id eq \"…\" (the lookups provisioning engines make before creating), plus startIndex / count paging (max 200) with no filter. Any other filter is 400 invalidFilter rather than silently wrong. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary SCIM: list or filter users
+     * @param {string} [filter]
+     * @param {number} [startIndex]
+     * @param {number} [count]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScimUserApiInterface
+     */
+    listScimRaw(requestParameters: ListScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseScimUserResource>>;
+    /**
+     * Reads < 300ms. Supports filter=userName eq \"…\", externalId eq \"…\" and id eq \"…\" (the lookups provisioning engines make before creating), plus startIndex / count paging (max 200) with no filter. Any other filter is 400 invalidFilter rather than silently wrong. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: list or filter users
+     */
+    listScim(requestParameters: ListScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseScimUserResource>;
+    /**
+     * Writes < 300ms. add / replace / remove on active, externalId, displayName, name (and its parts), userName / emails (must equal the current email). Both spellings are accepted: Okta\'s pathless {\"value\": {\"active\": false}} and Entra\'s {\"path\": \"active\", \"value\": \"False\"}. Paths this service has no column for are ignored, not refused — an Entra sync must not fail on \'department\'. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary SCIM: patch a user
+     * @param {string} id
+     * @param {PatchRequest} patchRequest
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScimUserApiInterface
+     */
+    patchScimRaw(requestParameters: PatchScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimUserResource>>;
+    /**
+     * Writes < 300ms. add / replace / remove on active, externalId, displayName, name (and its parts), userName / emails (must equal the current email). Both spellings are accepted: Okta\'s pathless {\"value\": {\"active\": false}} and Entra\'s {\"path\": \"active\", \"value\": \"False\"}. Paths this service has no column for are ignored, not refused — an Entra sync must not fail on \'department\'. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: patch a user
+     */
+    patchScim(requestParameters: PatchScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimUserResource>;
+    /**
+     * Writes < 300ms. Name, externalId and active are replaced; userName must equal the current email (it is the login identifier and cannot change through SCIM). Workspace owners are 403 SCIM_PROTECTED_USER. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary SCIM: replace a user
+     * @param {string} id
+     * @param {ScimUserResource} scimUserResource
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScimUserApiInterface
+     */
+    replaceScimRaw(requestParameters: ReplaceScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimUserResource>>;
+    /**
+     * Writes < 300ms. Name, externalId and active are replaced; userName must equal the current email (it is the login identifier and cannot change through SCIM). Workspace owners are 403 SCIM_PROTECTED_USER. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: replace a user
+     */
+    replaceScim(requestParameters: ReplaceScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimUserResource>;
+}
+/**
+ *
+ */
+export declare class ScimUserApi extends runtime.BaseAPI implements ScimUserApiInterface {
+    /**
+     * Writes < 300ms. userName must be an email (or emails[] must carry one). The user is created passwordless, provider SAML, with the connection\'s default role; active=false creates them already deactivated. An email that exists anywhere — this workspace or another — is 409 uniqueness. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: create a user
+     */
+    createScimRaw(requestParameters: CreateScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimUserResource>>;
+    /**
+     * Writes < 300ms. userName must be an email (or emails[] must carry one). The user is created passwordless, provider SAML, with the connection\'s default role; active=false creates them already deactivated. An email that exists anywhere — this workspace or another — is 409 uniqueness. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: create a user
+     */
+    createScim(requestParameters: CreateScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimUserResource>;
+    /**
+     * Writes < 300ms. Deactivates (status INACTIVE) rather than erasing: sign-in and token refresh are refused from now on, and everything the person did stays attributed to them. Erasure is a governed act with its own retention rules (governance.deletion), never a side effect of a directory sync. Idempotent. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: deprovision a user
+     */
+    deleteScimRaw(requestParameters: DeleteScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Writes < 300ms. Deactivates (status INACTIVE) rather than erasing: sign-in and token refresh are refused from now on, and everything the person did stays attributed to them. Erasure is a governed act with its own retention rules (governance.deletion), never a side effect of a directory sync. Idempotent. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: deprovision a user
+     */
+    deleteScim(requestParameters: DeleteScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: get a user
+     */
+    getScimRaw(requestParameters: GetScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimUserResource>>;
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: get a user
+     */
+    getScim(requestParameters: GetScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimUserResource>;
+    /**
+     * Reads < 300ms. Supports filter=userName eq \"…\", externalId eq \"…\" and id eq \"…\" (the lookups provisioning engines make before creating), plus startIndex / count paging (max 200) with no filter. Any other filter is 400 invalidFilter rather than silently wrong. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: list or filter users
+     */
+    listScimRaw(requestParameters: ListScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseScimUserResource>>;
+    /**
+     * Reads < 300ms. Supports filter=userName eq \"…\", externalId eq \"…\" and id eq \"…\" (the lookups provisioning engines make before creating), plus startIndex / count paging (max 200) with no filter. Any other filter is 400 invalidFilter rather than silently wrong. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: list or filter users
+     */
+    listScim(requestParameters?: ListScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseScimUserResource>;
+    /**
+     * Writes < 300ms. add / replace / remove on active, externalId, displayName, name (and its parts), userName / emails (must equal the current email). Both spellings are accepted: Okta\'s pathless {\"value\": {\"active\": false}} and Entra\'s {\"path\": \"active\", \"value\": \"False\"}. Paths this service has no column for are ignored, not refused — an Entra sync must not fail on \'department\'. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: patch a user
+     */
+    patchScimRaw(requestParameters: PatchScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimUserResource>>;
+    /**
+     * Writes < 300ms. add / replace / remove on active, externalId, displayName, name (and its parts), userName / emails (must equal the current email). Both spellings are accepted: Okta\'s pathless {\"value\": {\"active\": false}} and Entra\'s {\"path\": \"active\", \"value\": \"False\"}. Paths this service has no column for are ignored, not refused — an Entra sync must not fail on \'department\'. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: patch a user
+     */
+    patchScim(requestParameters: PatchScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimUserResource>;
+    /**
+     * Writes < 300ms. Name, externalId and active are replaced; userName must equal the current email (it is the login identifier and cannot change through SCIM). Workspace owners are 403 SCIM_PROTECTED_USER. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: replace a user
+     */
+    replaceScimRaw(requestParameters: ReplaceScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimUserResource>>;
+    /**
+     * Writes < 300ms. Name, externalId and active are replaced; userName must equal the current email (it is the login identifier and cannot change through SCIM). Workspace owners are 403 SCIM_PROTECTED_USER. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: replace a user
+     */
+    replaceScim(requestParameters: ReplaceScimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimUserResource>;
+}