Interface PodCreatorInput

interface PodCreatorInput {
    accountId: string;
    name?: string;
    settings?: Record<string, unknown>;
    webId?: string;
}

Properties

accountId name? settings? webId?

Properties

accountId

accountId: string

The ID of the account to create the pod for.

Optionalname

name?: string

The name to use when generating the base URL of the pod. If undefined, the pod will be created in the root of the server.

Optionalsettings

settings?: Record<string, unknown>

Additional settings to use when generating a pod.

OptionalwebId

webId?: string

The WebID to use for creation of the pod. This WebID will be used in the templates to, for example, determine who has access. If none is provided, the WebID generated by the creator will be used, in which case that WebID will also be linked to the account.

Settings

Member Visibility

On This Page

Properties