Skip to Content

create()

create(input): Promise<{ credentialCommand?: string; relay: { baseUrl: string; clientSetup?: { client: { id: string; name: string; }; copyText: string; notes: "separate-cli-home"[]; steps: ( | { environmentVariable: string; kind: "credential"; } | { content: string; kind: "configuration"; language: "toml"; path: string; } | { content: string; kind: "shell"; language: "sh"; } | { content: string; kind: "command"; })[]; }; createdAt: string; id: string; keyPreview: string; lastUsedAt: string | null; membershipRevision: number; name: string; projectId: string; realm: string; signedIn: boolean; signInIds: string[]; }; relayKey: string; }>;

Creates a relay backed by the given sign-ins and returns it with its key. The relay’s clientSetup describes the native client’s configuration. The key is returned only here.

Parameters

input

memberOptions?

Record<string, { credits?: { timing?: "immediate" | "deferred"; useWhenExhausted?: boolean; }; }>

Only entries included in the request are replaced; an empty object resets overrides.

name?

string = ...

signInIds

string[] = ...

Ordered subscriptions. The first is the primary identity.

Last updated on