@unkey/api/dist/commonjs/funcs/identitiesDeleteIdentity.d.ts

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.

import { UnkeyCore } from "../core.js";
import { RequestOptions } from "../lib/sdks.js";
import * as components from "../models/components/index.js";
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
import * as errors from "../models/errors/index.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import { UnkeyError } from "../models/errors/unkeyerror.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
 * Delete Identity
 *
 * @remarks
 * Permanently delete an identity. This operation cannot be undone.
 *
 * Use this for data cleanup, compliance requirements, or when removing entities from your system.
 *
 * > **Important**
 * > Requires `identity.*.delete_identity` permission
 * > Associated API keys remain functional but lose shared resources
 * > External ID becomes available for reuse immediately
 *
 * If set, this operation will use {@link Security.rootKey} from the global security.
 */
export declare function identitiesDeleteIdentity(client: UnkeyCore, request: components.V2IdentitiesDeleteIdentityRequestBody, options?: RequestOptions): APIPromise<Result<components.V2IdentitiesDeleteIdentityResponseBody, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.NotFoundErrorResponse | errors.TooManyRequestsErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=identitiesDeleteIdentity.d.ts.map