@unkey/api/dist/esm/funcs/keysRerollKey.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";
/**
 * Reroll Key
 *
 * @remarks
 * Generate a new API key while preserving the configuration from an existing key.
 *
 * This operation creates a fresh key with a new token while maintaining all settings from the original key:
 * - Permissions and roles
 * - Custom metadata
 * - Rate limit configurations
 * - Identity associations
 * - Remaining credits
 * - Recovery settings
 *
 * **Key Generation:**
 * - The system attempts to extract the prefix from the original key
 * - If prefix extraction fails, the default API prefix is used
 * - Key length follows the API's default byte configuration (or 16 bytes if not specified)
 *
 * **Original Key Handling:**
 * - The original key will be revoked after the duration specified in `expiration`
 * - Set `expiration` to 0 to revoke immediately
 * - This allows for graceful key rotation with an overlap period
 *
 * Common use cases include:
 * - Rotating keys for security compliance
 * - Issuing replacement keys for compromised credentials
 * - Creating backup keys with identical permissions
 *
 * **Important:** Analytics and usage metrics are tracked at both the key level AND identity level. If the original key has an identity, the new key will inherit it, allowing you to track usage across both individual keys and the overall identity.
 *
 * **Required Permissions**
 *
 *  Your root key must have:
 *  - `api.*.create_key` or `api.<api_id>.create_key`
 *  - `api.*.encrypt_key` or `api.<api_id>.encrypt_key` (only when the original key is recoverable)
 *
 * If set, this operation will use {@link Security.rootKey} from the global security.
 */
export declare function keysRerollKey(client: UnkeyCore, request: components.V2KeysRerollKeyRequestBody, options?: RequestOptions): APIPromise<Result<components.V2KeysRerollKeyResponseBody, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.NotFoundErrorResponse | errors.TooManyRequestsErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=keysRerollKey.d.ts.map