@unkey/api
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.
29 lines • 1.86 kB
TypeScript
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 * as operations from "../models/operations/index.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
import { PageIterator } from "../types/operations.js";
/**
* List Identities
*
* @remarks
* Get a paginated list of all identities in your workspace. Returns metadata and rate limit configurations.
*
* Perfect for building management dashboards, auditing configurations, or browsing your identities.
*
* > **Important**
* > Requires `identity.*.read_identity` permission
*
* If set, this operation will use {@link Security.rootKey} from the global security.
*/
export declare function identitiesListIdentities(client: UnkeyCore, request: components.V2IdentitiesListIdentitiesRequestBody, options?: RequestOptions): APIPromise<PageIterator<Result<operations.IdentitiesListIdentitiesResponse, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.TooManyRequestsErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>, {
cursor: string;
}>>;
//# sourceMappingURL=identitiesListIdentities.d.ts.map