@unkey/api
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.
113 lines • 5.04 kB
JavaScript
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import { encodeJSON } from "../lib/encodings.js";
import { matchStatusCode } from "../lib/http.js";
import * as M from "../lib/matchers.js";
import { compactMap } from "../lib/primitives.js";
import { safeParse } from "../lib/schemas.js";
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
import { pathToFunc } from "../lib/url.js";
import * as components from "../models/components/index.js";
import * as errors from "../models/errors/index.js";
import { APIPromise } from "../types/async.js";
/**
* List API keys
*
* @remarks
* Retrieve a paginated list of API keys for dashboard and administrative interfaces.
*
* Use this to build key management dashboards, filter keys by user with `externalId`, or retrieve key details for administrative purposes. Each key includes status, metadata, permissions, and usage limits.
*
* **Important**: Set `decrypt: true` only in secure contexts to retrieve plaintext key values from recoverable keys.
*
* **Required Permissions**
*
* Your root key must have one of the following permissions for basic key listing:
* - `api.*.read_key` (to read keys from any API)
* - `api.<api_id>.read_key` (to read keys from a specific API)
*
* Additionally, you need read access to the API itself:
* - `api.*.read_api` or `api.<api_id>.read_api`
*
* Additional permission required for decrypt functionality:
* - `api.*.decrypt_key` or `api.<api_id>.decrypt_key`
*
* If set, this operation will use {@link Security.rootKey} from the global security.
*/
export function apisListKeys(client, request, options) {
return new APIPromise($do(client, request, options));
}
async function $do(client, request, options) {
const parsed = safeParse(request, (value) => components.V2ApisListKeysRequestBody$outboundSchema.parse(value), "Input validation failed");
if (!parsed.ok) {
return [parsed, { status: "invalid" }];
}
const payload = parsed.value;
const body = encodeJSON("body", payload, { explode: true });
const path = pathToFunc("/v2/apis.listKeys")();
const headers = new Headers(compactMap({
"Content-Type": "application/json",
Accept: "application/json",
}));
const secConfig = await extractSecurity(client._options.rootKey);
const securityInput = secConfig == null ? {} : { rootKey: secConfig };
const requestSecurity = resolveGlobalSecurity(securityInput, [0]);
const context = {
options: client._options,
baseURL: options?.serverURL ?? client._baseURL ?? "",
operationID: "apis.listKeys",
oAuth2Scopes: null,
resolvedSecurity: requestSecurity,
securitySource: client._options.rootKey,
retryConfig: options?.retries
|| client._options.retryConfig
|| {
strategy: "backoff",
backoff: {
initialInterval: 50,
maxInterval: 1000,
exponent: 1.5,
maxElapsedTime: 10000,
},
retryConnectionErrors: true,
}
|| { strategy: "none" },
retryCodes: options?.retryCodes || ["5XX"],
};
const requestRes = client._createRequest(context, {
security: requestSecurity,
method: "POST",
baseURL: options?.serverURL,
path: path,
headers: headers,
body: body,
userAgent: client._options.userAgent,
timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
}, options);
if (!requestRes.ok) {
return [requestRes, { status: "invalid" }];
}
const req = requestRes.value;
const doResult = await client._do(req, {
context,
isErrorStatusCode: (statusCode) => matchStatusCode({ status: statusCode }, ["4XX", "5XX"]),
retryConfig: context.retryConfig,
retryCodes: context.retryCodes,
});
if (!doResult.ok) {
return [doResult, { status: "request-error", request: req }];
}
const response = doResult.value;
const responseFields = {
HttpMeta: { Response: response, Request: req },
};
const [result] = await M.match(M.json(200, components.V2ApisListKeysResponseBody$inboundSchema), M.jsonErr(400, errors.BadRequestErrorResponse$inboundSchema), M.jsonErr(401, errors.UnauthorizedErrorResponse$inboundSchema), M.jsonErr(403, errors.ForbiddenErrorResponse$inboundSchema), M.jsonErr(404, errors.NotFoundErrorResponse$inboundSchema), M.jsonErr(429, errors.TooManyRequestsErrorResponse$inboundSchema, {
ctype: "application/problem+json",
}), M.jsonErr(500, errors.InternalServerErrorResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
if (!result.ok) {
return [result, { status: "complete", request: req, response }];
}
return [result, { status: "complete", request: req, response }];
}
//# sourceMappingURL=apisListKeys.js.map