@unkey/api
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.
25 lines • 1.72 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 { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
* Get Identity
*
* @remarks
* Retrieve an identity by external ID. Returns metadata, rate limits, and other associated data.
*
* Use this to check if an identity exists, view configurations, or build management dashboards.
*
* > **Important**
* > Requires `identity.*.read_identity` permission
*
* If set, this operation will use {@link Security.rootKey} from the global security.
*/
export declare function identitiesGetIdentity(client: UnkeyCore, request: components.V2IdentitiesGetIdentityRequestBody, options?: RequestOptions): APIPromise<Result<components.V2IdentitiesGetIdentityResponseBody, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.NotFoundErrorResponse | errors.TooManyRequestsErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=identitiesGetIdentity.d.ts.map