@unkey/api/dist/esm/funcs/portalCreateSession.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 * as operations from "../models/operations/index.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
 * Create portal session
 *
 * @remarks
 * Create a short-lived session token for an end user to access the Customer Portal.
 *
 * The returned session ID is valid for 15 minutes and can be exchanged exactly once
 * for a 24-hour browser session via `portal.exchangeSession`. Redirect the end user
 * to the returned URL to start the portal experience.
 *
 * **Required Permissions**
 *
 * Your root key must be associated with a workspace that has an enabled portal configuration.
 *
 * If set, this operation will use {@link Security.rootKey} from the global security.
 */
export declare function portalCreateSession(client: UnkeyCore, request: components.V2PortalCreateSessionRequestBody, options?: RequestOptions): APIPromise<Result<operations.PortalCreateSessionResponse, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.NotFoundErrorResponse | errors.TooManyRequestsErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=portalCreateSession.d.ts.map